git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale

From
Jean-Noël Avila <avila.jn@gmail.com>
Date
Apr 12, 2021, 13:37 UTC
Message-ID
<d2e78646-6735-2a27-735c-331de6411ca2@gmail.com>
In-Reply-To
<20210409040301.3260358-1-firminmartin24@gmail.com>
Le 09/04/2021 à 06:02, Firmin Martin a écrit :
Show 5 quoted lines
> This patch series aims to make the documentation fully compliant to the
> CodingGuidelines regarding monospace font. After it, new contributors
> who just want to change a little portion of the documention could just
> look around how it has been done without being confused by the
> inconsistency between the documentation and the CodingGuidelines.

Thank you for tackling the task of formating the docu and directing to CodingGuidelines for some markup rules. It appears that the last rule about backticks is wrong with late Asciidoctor, for which backticks are only a font switcher and no longer hold any semantic meaning. This means that double-hyphens may need escaping (see: https://asciidoctor.org/docs/migration/#migration-cheatsheet) when switching style and tools.

One other rule worth adding would be that tabs are banned from asciidoc because they cannot always be matched with correct indentation.

Previous: Firmin MartinNext: Firmin Martin
Message 17 of 20 in “[GSoC] doc: (monospace) apply CodingGuidelines on a large-scale”
  1. 00/13 [GSoC] doc: (monospace) apply CodingGuidelines on a large-scaleFirmin Martin, Apr 9, 2021
  2. 01/13 doc: typeset command-line options in monospaceFirmin Martin, Apr 9, 2021
  3. Bagas SanjayaApr 9, 2021
  4. Firmin MartinApr 10, 2021
  5. 03/13 doc: typeset configuration options in monospaceFirmin Martin, Apr 9, 2021
  6. 02/13 doc: typeset branches and remotes in monospaceFirmin Martin, Apr 9, 2021
  7. 05/13 doc: typeset git-svn subcommands in monospaceFirmin Martin, Apr 9, 2021
  8. 06/13 doc: typeset dummy URLs and protocols in monospaceFirmin Martin, Apr 9, 2021
  9. 07/13 doc: typeset git dotfiles in monospaceFirmin Martin, Apr 9, 2021
  10. 04/13 doc: typeset git-related commands in monospaceFirmin Martin, Apr 9, 2021
  11. 11/13 doc: typeset config option entries in monospaceFirmin Martin, Apr 9, 2021
  12. 08/13 doc: typeset filepath and $variables in monospaceFirmin Martin, Apr 9, 2021
  13. 10/13 doc: typeset more command entries in monospaceFirmin Martin, Apr 9, 2021
  14. 09/13 doc: typeset command/option/value entries in monospaceFirmin Martin, Apr 9, 2021
  15. 13/13 doc: typeset common programs in monospaceFirmin Martin, Apr 9, 2021
  16. 12/13 doc: typeset environment vars without $ in monospaceFirmin Martin, Apr 9, 2021
  17. Jean-Noël AvilaApr 12, 2021
  18. Firmin MartinApr 13, 2021
  19. Jean-Noël AvilaApr 19, 2021
  20. Jean-Noël AvilaApr 19, 2021

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.