On Thu, Mar 20, 2025 at 4:41 AM Patrick Steinhardt <ps@xxxxxx> wrote: > > On Wed, Mar 19, 2025 at 02:20:15PM -0300, Lucas Seiki Oshiro wrote: > > From Documentation/config.adoc: > > > > """ > > The file consists of sections and variables. A section begins with > > the name of the section in square brackets and continues until the next > > section begins. Section names are case-insensitive. Only alphanumeric > > characters, `-` and `.` are allowed in section names. Each variable > > must belong to some section, which means that there must be a section > > header before the first setting of a variable. > > > > [...] > > > > Subsection names are case sensitive and can contain any characters except > > newline and the null byte. > > > > The variable names are case-insensitive, allow only alphanumeric characters > > and `-`, and must start with an alphabetic character. > > """ > > I don't think it's necessary to quote this whole paragraph here, as most > of us should be quite familiar with its format. I'd rather summarize the > info a bit and explain how we can use the userdiff patterns for the > general structure of the config. And in case there are any subtleties in > the format it may make sense to specifically point out those instead of > quoting the whole manual. And, if we really felt it important to direct readers to the full text, we could instruct them to do something like `git show <sensible-hash>:Documentation/config.adoc`—in other words, the text is a part of this commit (and its parent) even if we don't (fully) quote it here. Cheers, Ben
