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

[PATCH 0/2] Convert SubmittingPatches to AsciiDoc

From
brian m. carlson <sandals@crustytoothpaste.net>
Date
Oct 29, 2017, 21:13 UTC
Message-ID
<20171029211308.272673-1-sandals@crustytoothpaste.net>

This series converts SubmittingPatches into AsciiDoc and builds it as part of the technical documentation. The goal is to provide a format that is more easily linkable both from our website and by others, as the Git Project's patch submission standards are widely referenced and used as examples.

The decision of what anchors to provide was mostly a matter of judgment, but as a rule, I provided anchors to anything I've seen referenced in blog posts or other coding standards. Opinions on my anchor names are welcome.

As explained, I preferred to avoid renaming SubmittingPatches since it's referred to in so many places, including our own website. If the list decides that it's better to just rename, I can do that; it does simplify the patch somewhat.

The documentation has been tested with both AsciiDoc and Asciidoctor and looks and functions fine either way. (I normally use Asciidoctor, but did test both.)

The first patch is a bridge to help AsciiDoc and Asciidoctor compatibility. It enables Asciidoctor's compatibility mode, which currently has no effect on our codebase[0]. I wrote it thinking that I would use the AsciiDoc curly quote syntax, but realized that we use the plain ASCII version everywhere. It can be kept or dropped, but I hope that it might avoid some future compatibility issues down the line. I had intended to add it originally when writing the USE_ASCIIDOCTOR support, but it slipped my mind.

I will admit that this series benefits me personally, as I do want to link to our docs in this way, but I've seen other people want to as well, and I feel that helping people find documentation on writing better commit messages and such would be beneficial for the open source community as a whole.

I expect to be sending a series on top of this one that provides support for reproducible builds when built with a suitable version of Asciidoctor.

[0] Running "make clean && make html" results in no changes to the Documentation directory outside of the change to the Makefile itself.

brian m. carlson (2):
  Documentation: enable compat-mode for Asciidoctor
  Documentation: convert SubmittingPatches to AsciiDoc
 Documentation/.gitignore        |   1 +
 Documentation/Makefile          |   6 +
 Documentation/SubmittingPatches | 331 +++++++++++++++++++++-------------------
 3 files changed, 184 insertions(+), 154 deletions(-)
Next: brian m. carlson
Message 1 of 10 in “Convert SubmittingPatches to AsciiDoc”
  1. 0/2 Convert SubmittingPatches to AsciiDocbrian m. carlson, Oct 29, 2017
  2. 1/2 Documentation: enable compat-mode for Asciidoctorbrian m. carlson, Oct 29, 2017
  3. 2/2 Documentation: convert SubmittingPatches to AsciiDocbrian m. carlson, Oct 29, 2017
  4. Junio C HamanoOct 30, 2017
  5. Johannes SchindelinOct 30, 2017
  6. Paolo CiarrocchiOct 30, 2017
  7. Johannes SchindelinOct 31, 2017
  8. Paolo CiarrocchiOct 31, 2017
  9. brian m. carlsonOct 30, 2017
  10. brian m. carlsonOct 31, 2017

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.