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

[PATCH v3 2/6] Documentation/technical/api-config.txt: fix formatting

From
SZEDER Gábor <szeder.dev@gmail.com>
Date
Mar 29, 2019, 12:35 UTC
Message-ID
<20190329123520.27549-3-szeder.dev@gmail.com>
In-Reply-To
<20190329123520.27549-1-szeder.dev@gmail.com>

Asciidoctor versions v1.5.7 or later print the following warning while building the documentation:

      ASCIIDOC technical/api-config.html
  asciidoctor: WARNING: api-config.txt: line 232: unterminated listing block

This highlight an issue (even with older Asciidoctor versions) where the length of the '----' lines surrounding a code example don't match, and the rest of the document is rendered in monospace.

Fix this by making sure that the length of those lines match.
The page rendered with AsciiDoc doesn't have this formatting issue.
Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com>
---
 Documentation/technical/api-config.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/technical/api-config.txt b/Documentation/technical/api-config.txt
index fa39ac9d71..7d20716c32 100644
--- a/Documentation/technical/api-config.txt
+++ b/Documentation/technical/api-config.txt
@@ -229,7 +229,7 @@ A `config_set` can be used to construct an in-memory cache for
 config-like files that the caller specifies (i.e., files like `.gitmodules`,
 `~/.gitconfig` etc.). For example,
 
----------------------------------------
+----------------------------------------
 struct config_set gm_config;
 git_configset_init(&gm_config);
 int b;
-- 
2.21.0.539.g07239c3a71.dirty
Previous: SZEDER GáborNext: SZEDER Gábor
Message 18 of 25 in “Documentation/git-diff-tree.txt: fix formatting”
  1. 1/3 Documentation/git-diff-tree.txt: fix formattingSZEDER Gábor, Mar 24, 2019
  2. 2/3 Documentation/technical/api-config.txt: fix formattingSZEDER Gábor, Mar 24, 2019
  3. 3/3 Documentation/technical/protocol-v2.txt: fix formattingSZEDER Gábor, Mar 24, 2019
  4. SZEDER GáborMar 24, 2019
  5. 0/6 Asciidoctor-related formatting and CI fixesSZEDER Gábor, Mar 24, 2019
  6. 1/6 Documentation/git-diff-tree.txt: fix formattingSZEDER Gábor, Mar 24, 2019
  7. 2/6 Documentation/technical/api-config.txt: fix formattingSZEDER Gábor, Mar 24, 2019
  8. 3/6 Documentation/technical/protocol-v2.txt: fix formattingSZEDER Gábor, Mar 24, 2019
  9. 4/6 ci: install Asciidoctor in 'ci/install-dependencies.sh'SZEDER Gábor, Mar 24, 2019
  10. Johannes SchindelinMar 25, 2019
  11. SZEDER GáborMar 25, 2019
  12. Johannes SchindelinMar 26, 2019
  13. 6/6 ci: fix AsciiDoc/Asciidoctor stderr check in the documentation build jobSZEDER Gábor, Mar 24, 2019
  14. 5/6 ci: stick with Asciidoctor v1.5.8 for nowSZEDER Gábor, Mar 24, 2019
  15. Jeff KingMar 26, 2019
  16. 0/6 Asciidoctor-related formatting and CI fixesSZEDER Gábor, Mar 29, 2019
  17. 1/6 Documentation/git-diff-tree.txt: fix formattingSZEDER Gábor, Mar 29, 2019
  18. 2/6 Documentation/technical/api-config.txt: fix formattingSZEDER Gábor, Mar 29, 2019
  19. 4/6 ci: install Asciidoctor in 'ci/install-dependencies.sh'SZEDER Gábor, Mar 29, 2019
  20. 3/6 Documentation/technical/protocol-v2.txt: fix formattingSZEDER Gábor, Mar 29, 2019
  21. 5/6 ci: stick with Asciidoctor v1.5.8 for nowSZEDER Gábor, Mar 29, 2019
  22. 5/6 ci: stick with Asciidoctor v1.5.8 for nowSZEDER Gábor, Mar 29, 2019
  23. Martin ÅgrenApr 3, 2019
  24. 6/6 ci: fix AsciiDoc/Asciidoctor stderr check in the documentation build jobSZEDER Gábor, Mar 29, 2019
  25. Johannes SchindelinMar 29, 2019

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.