Lubuntu/britney2-ubuntu
8
0
Fork 0
mirror of https://git.launchpad.net/~ubuntu-release/britney/+git/britney2-ubuntu synced 2025-06-05 14:51:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc/hints.md: remove gendered pronouns, to match other documentation

Browse Source 
Signed-off-by: Adam D. Barratt <adam@adam-barratt.org.uk>
This commit is contained in:
Adam D. Barratt 2017-10-05 17:54:06 +00:00
parent c6170a6042
commit 5e58d18676
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/hints.md
View File

@ -6,8 +6,8 @@
This document describes the "britney hints". These are basically This document describes the "britney hints". These are basically
small instructions to britney. The vast majority of them involve small instructions to britney. The vast majority of them involve
overriding a quality gating policy in britney. However, there are a overriding a quality gating policy in britney. However, there are a
few hints that assist britney into finding solutions that she cannot few hints that assist britney into finding solutions that it cannot
compute herself. compute itself.
## Related configuration ## Related configuration
@ -18,7 +18,7 @@ configurations that defines a "hint file" and the related hint
permissions for it. permissions for it.
For each `HINTS_<NAME>` configuration, britney will attempt to read For each `HINTS_<NAME>` configuration, britney will attempt to read
`<HINTSDIR>/<name>`. Note that she lowercases `<NAME>` when looking `<HINTSDIR>/<name>`. Note that it lowercases `<NAME>` when looking
for the file. for the file.
@ -215,7 +215,7 @@ compared to the original situation, the action is committed.
This hint is primarily useful if britney fails to compute a valid This hint is primarily useful if britney fails to compute a valid
solution for a concrete problem with a valid solution. Although, in solution for a concrete problem with a valid solution. Although, in
many cases, Britney will generally figure out the solution on her own. many cases, Britney will generally figure out the solution on its own.
Note that for `easy` the `<action list>` must have at least two Note that for `easy` the `<action list>` must have at least two
elements. There is no use-case where a single element for easy will elements. There is no use-case where a single element for easy will
@ -239,7 +239,7 @@ rather expensive and should be used sparingly.
This hint is primarily useful if britney fails to compute a valid This hint is primarily useful if britney fails to compute a valid
solution for a concrete problem with a valid solution. Although, in solution for a concrete problem with a valid solution. Although, in
many cases, Britney will generally figure out the solution on her own. many cases, Britney will generally figure out the solution on its own.
*Caveat*: Due to "uninstallability trading", this hint may cause *Caveat*: Due to "uninstallability trading", this hint may cause
undesireable changes to the target suite. In practise, this is rather undesireable changes to the target suite. In practise, this is rather