Admonitions
===========

Automated index of all admonitions (in this manual as well as in
python code documentation). Somewhat like a FAQ list.

For simplicity, we only use four admonitions:

* **error**: In- or external bugs (what *should* be fixed eventually somehow).
* **attention**: Something not obvious you should be aware of (but cannot really be fixed).
* **note**: Internal TODOS or other noteworthy stuff.
* **tip**: Free tip.

error
------------
* `administrator <administrator.html>`_: Fails to build "all" packages with "build archall" flag set to arch "x" in case DSP has >= 1 arch "all" and >=1 arch "y" binary package!
* `administrator <administrator.html>`_: For some distributions, schroot doesn't work with systemd (/dev/shm)!
* `administrator <administrator.html>`_: LVM chroots fail running lvcreate with 'not found: device not cleared'!
* `administrator <administrator.html>`_: debootstrap fails for <=lenny chroots on >=jessie host kernel (uname)!
* `administrator <administrator.html>`_: eatmydata: Builds fail when linked with openvc!
* `consumer <consumer.html>`_: I can't get credentials to work from the shell!
* `consumer <consumer.html>`_: squeeze or older only: apt secure problems after initial (unauthorized) install of the archive-key package!
* `python/mini_buildd.schroot <python/mini_buildd.schroot.html>`_: **stale schroot sessions**: 'target is busy' on session close (stale schroot sessions).

attention
------------
* `administrator <administrator.html>`_: Be sure to use the exact same host names as given in the resp. instance's Daemon configuration!
* `administrator <administrator.html>`_: Don't add or delete Uploader instances manually!
* `administrator <administrator.html>`_: The Daemon instance does not touch the GPG setup once it's created -- *unless you do an explicit remove* on the instance.
* `administrator <administrator.html>`_: The SSL private key must be readable by user or group ``mini-buildd``.

note
------------
* `administrator <administrator.html>`_: TODO: More testing and clarification needed in this section.
* `consumer <consumer.html>`_: Feb 2022: Copied from local docs. Needs verification, maybe update.
* `python/mini_buildd <python/mini_buildd.html>`_: **pycompat**: With ``python 3.8``, just use ``shlex.join``."""
* `python/mini_buildd <python/mini_buildd.html>`_: **pycompat**: With ``python 3.9``, just use ``str.removeprefix``."""
* `python/mini_buildd.builder <python/mini_buildd.builder.html>`_: If the constructor fails, no buildresult would be uploaded (and packaging would hang). Keep it simple && be sure this does not fail on 'normal' error conditions.
* `python/mini_buildd.client <python/mini_buildd.client.html>`_: **pycompat**: With ``python 3.7``, update interactive loop (see ``_get_action()``) to Assignment Expressions (PEP-0572).
* `python/mini_buildd.dist <python/mini_buildd.dist.html>`_: **pycompat**: With ``python 3.7``, this could be a namedtuple w/ defaults.
* `python/mini_buildd.sbuild <python/mini_buildd.sbuild.html>`_: This will iterate all lines of the build log,

tip
------------
* `abstract <abstract.html>`_: Some links do not work in this manual?
* `administrator <administrator.html>`_: Can I manually instantiate a build chroot to repeat/debug a failed build?
* `administrator <administrator.html>`_: Can I skip migrating from 0.8.x?
* `administrator <administrator.html>`_: How do I use foreign-architecture chroots with qemu?
* `administrator <administrator.html>`_: How much disk space do I need to run mini-buildd?
* `administrator <administrator.html>`_: How to enable encrypted uploads (FTPS)?
* `administrator <administrator.html>`_: In the web configurator, you may use the ``PCA`` shortcut (``prepare``, ``check`` and ``activate``).
* `administrator <administrator.html>`_: My chroot creation fails due to missing arch in archive (partial mirror)?
* `administrator <administrator.html>`_: What APT keys is my Release file signed with?
* `administrator <administrator.html>`_: What's ``eatmydata`` and ``ccache``?
* `administrator <administrator.html>`_: sudo fails with "sudo: no tty present and no askpass program specified"?
* `consumer <consumer.html>`_: How do I verify mini-buildd's APT key?
* `consumer <consumer.html>`_: How to can I upgrade after Debian main release version fix?
* `consumer <consumer.html>`_: What's the ``hotfix`` suite good for?
* `developer <developer.html>`_: Can I access built packages that have not been installed into the repository?
* `developer <developer.html>`_: Do mini-buildd commands support bash autocompletion?
* `developer <developer.html>`_: Is package building parallel? (a.k.a. Where is the 'sbuild_jobs' settings?)
* `developer <developer.html>`_: Is there a changelog mode to help with `Upload Options` for emacs?
