diff options
| author | Julian Andres Klode <jak@debian.org> | 2026-04-09 11:45:36 +0200 |
|---|---|---|
| committer | Julian Andres Klode <jak@debian.org> | 2026-05-01 16:09:07 +0000 |
| commit | a56c9b0b50d5d16838f07724dc480c90501875a0 (patch) | |
| tree | 8e105f2caa39a3e5618fbb82a2af07b72a079d3b | |
| parent | b53eadc73ca20aa95ade7370d16f064dee81aa03 (diff) | |
sources.list(5): Document Contact/Bugs/Description fields
Document Contact, Bugs, and Description fields as the recommended
way to inform users about a repository and how to contact upstream.
Thanks: josch for the suggestion
| -rw-r--r-- | doc/sources.list.5.xml | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/sources.list.5.xml b/doc/sources.list.5.xml index 09f824f25..b73a09f6f 100644 --- a/doc/sources.list.5.xml +++ b/doc/sources.list.5.xml @@ -442,7 +442,31 @@ Signed-By: however support additional types of IDs, and APT does not perform any checks so far. </para> </listitem> + </itemizedlist> + </para> + <para> + In the deb822 format, it can be useful to describe the sources in more detail. + The following options are not directly used by APT, + but suggested to be included by third-parties when providing <filename>.sources</filename> files to users. + <itemizedlist> + <listitem> + <para><option>Contact</option> + specifies the preferred addresses to reach the repository operators on one or more lines. + It should be a comma-separated list of RFC5322 email addresses or URLs. + </para> + </listitem> + <listitem> + <para><option>Bugs</option> + specifies an HTTPS URL to a public bug tracker or instructions on how to report bugs. + </para> + </listitem> + <listitem> + <para><option>Description</option> + specifies a description for the repository. This is a multi-line field, the first line is a summary, + the remaining lines may add more description. + </para> + </listitem> </itemizedlist> </para> |