21 Commits

Author SHA1 Message Date
Niels Thykier
e5d790f592 Typo fix
Signed-off-by: Niels Thykier <niels@thykier.net>
2018-03-24 18:11:14 +00:00
Niels Thykier
20f709e157 doc: Wording/typos
Signed-off-by: Niels Thykier <niels@thykier.net>
2017-12-05 06:31:23 +00:00
Niels Thykier
0f41b1b6df Rewrite hints as restructured text
Signed-off-by: Niels Thykier <niels@thykier.net>
2017-12-03 12:56:48 +00:00
Niels Thykier
90e4bb6ba2 Rewrite documentation in sphinx
Signed-off-by: Niels Thykier <niels@thykier.net>
2017-12-03 12:06:37 +00:00
Adam D. Barratt
3ee3ba5463 doc/hints.md: subject-number agreement fix
Signed-off-by: Adam D. Barratt <adam@adam-barratt.org.uk>
2017-10-05 17:56:25 +00:00
Adam D. Barratt
f7173b9d66 doc/hints.md: fix another couple of "Britney" -> "britney"
Signed-off-by: Adam D. Barratt <adam@adam-barratt.org.uk>
2017-10-05 17:54:49 +00:00
Adam D. Barratt
5e58d18676 doc/hints.md: remove gendered pronouns, to match other documentation
Signed-off-by: Adam D. Barratt <adam@adam-barratt.org.uk>
2017-10-05 17:54:06 +00:00
Adam D. Barratt
c6170a6042 docs/hints.md: be consistent of capitalisation of "britney"
Only capitalise it at the start of sentences, not within them

Signed-off-by: Adam D. Barratt <adam@adam-barratt.org.uk>
2017-10-05 17:52:27 +00:00
Adam D. Barratt
ac39d2448f doc/hints.md: grammar fix - "if it was" -> "if it were"
This phrasing is the subjunctive mood, for which English always uses
"were"

Signed-off-by: Adam D. Barratt <adam@adam-barratt.org.uk>
2017-10-05 17:50:10 +00:00
Niels Thykier
8352d62999 Improve bug example and avoid usage of "RC"
Signed-off-by: Niels Thykier <niels@thykier.net>
2017-08-26 17:29:52 +00:00
Niels Thykier
7e2c62a600 Avoid gendered pronoun for britney
Signed-off-by: Niels Thykier <niels@thykier.net>
2017-08-26 17:17:22 +00:00
Niels Thykier
e2cbe15157 Improve documentation based on review in #d-release
Signed-off-by: Niels Thykier <niels@thykier.net>
2017-08-26 15:18:48 +00:00
Niels Thykier
cb5d888733 doc: Document basic migration handling/debugging
Signed-off-by: Niels Thykier <niels@thykier.net>
2017-08-26 14:09:19 +00:00
Niels Thykier
77d737cefe doc/hints.md: New doc based on the RT README for hints
There is no reason why the hint documentation is not in the britney
code base (particularly, as we would be more likely to update it when
we add new hints).

Signed-off-by: Niels Thykier <niels@thykier.net>
2017-08-13 19:25:08 +00:00
Niels Thykier
2692b503d4 Drop auto-generated doxygen documentation
Signed-off-by: Niels Thykier <niels@thykier.net>
2017-08-13 17:13:08 +00:00
Niels Thykier
6774ed6877 Fixed a typo in the doxygen.conf file
Signed-off-by: Niels Thykier <niels@thykier.net>
2011-12-23 11:16:32 +01:00
Mehdi Dogguy
6ecb711860 Typo fix 2011-10-19 20:02:29 +00:00
Fabio Tranchitella
70be82be3f Updated documentation. 2006-08-18 21:24:26 +00:00
Fabio Tranchitella
8bd331e037 Several important fixes to excuse generation and upgraderun; rebuild documentation. 2006-07-22 07:31:22 +00:00
Fabio Tranchitella
ec4469c589 Added a verbose explanation of how the excuses are generated as docstring for the module britney. 2006-06-25 10:05:35 +00:00
Fabio Tranchitella
f7b9bdc1f4 Support for fake source packages, which solved the last compatibility issues for the old britney code.
Added documentation and comments to explain the code. It is possible to generate HTML and LaTeX documentation using doxygen.
2006-06-24 17:49:43 +00:00