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

Re: [PATCH v4 4/6] doc: use modern "`"-style code fencing

From
Junio C Hamano <gitster@pobox.com>
Date
Oct 2, 2017, 01:35 UTC
Message-ID
<xmqqtvziqqku.fsf@gitster.mtv.corp.google.com>
In-Reply-To
<20171002000630.GA63556@D-10-157-251-166.dhcp4.washington.edu>
Taylor Blau <me@ttaylorr.com> writes:
Show 9 quoted lines
>> Is this just me who wants to do s/fenc/quot/g?  Unless somebody
>> objects, I'd do so while queuing.
>
> I don't object, I think that fencing is less appropriate than quoting.
> I couldn't find the term myself when writing this commit :-).
>
> I am happy to send out v5 of this patch series with this commit
> re-written, or you can change it while queuing. Whichever is easier for
> you.

Just FYI, here is what I ended up with. I do not think this is about "modern" vs "old style"; it is more about using the more appropriate mark-up and our desire has always been to use `literal` for things that users need to type literally.

I notice that I didn't remove 'modern' from the title in the versoin below, though.

Thanks.
commit a184d836bcf1a557520095a90b22edf659ee88f2
Author: Taylor Blau <me@ttaylorr.com>
Date:   Sun Oct 1 09:18:50 2017 -0700
    doc: use modern "`<literal>`"-style quoting for literal strings
    
    "'<string>'"-style quoting is not appropriate when quoting literal
    strings in the "Documentation/" subtree.
    
    In preparation for adding additional information to this section of
    git-for-each-ref(1)'s documentation, update them to use "`<literal>`"
    instead.
    
    Signed-off-by: Taylor Blau <me@ttaylorr.com>
    Signed-off-by: Junio C Hamano <gitster@pobox.com>
Previous: Taylor BlauNext: Jeff King
Message 39 of 78 in “Support %(trailers) arguments in for-each-ref(1)”
  1. 0/5 Support %(trailers) arguments in for-each-ref(1)Taylor Blau, Sep 30, 2017
  2. 1/5 pretty.c: delimit "%(trailers)" arguments with ","Taylor Blau, Sep 30, 2017
  3. Jeff KingSep 30, 2017
  4. 2/5 t6300: refactor %(trailers) testsTaylor Blau, Sep 30, 2017
  5. Jeff KingSep 30, 2017
  6. 3/5 ref-filter.c: add trailer options to used_atomTaylor Blau, Sep 30, 2017
  7. Jeff KingSep 30, 2017
  8. 4/5 ref-filter.c: use trailer_opts to format trailersTaylor Blau, Sep 30, 2017
  9. Jeff KingSep 30, 2017
  10. Junio C HamanoOct 1, 2017
  11. Junio C HamanoOct 1, 2017
  12. Jeff KingOct 2, 2017
  13. Taylor BlauOct 2, 2017
  14. 5/5 ref-filter.c: parse trailers arguments with %(contents) atomTaylor Blau, Sep 30, 2017
  15. Jeff KingSep 30, 2017
  16. Jeff KingSep 30, 2017
  17. 0/6 Support %(trailers) arguments in for-each-ref(1)Taylor Blau, Sep 30, 2017
  18. 1/6 pretty.c: delimit "%(trailers)" arguments with ","Taylor Blau, Sep 30, 2017
  19. 2/6 t6300: refactor %(trailers) testsTaylor Blau, Sep 30, 2017
  20. 4/6 doc: use modern "`"-style code fencingTaylor Blau, Sep 30, 2017
  21. 5/6 ref-filter.c: use trailer_opts to format trailersTaylor Blau, Sep 30, 2017
  22. 3/6 doc: 'trailers' is the preferred way to format trailersTaylor Blau, Sep 30, 2017
  23. 6/6 ref-filter.c: parse trailers arguments with %(contents) atomTaylor Blau, Sep 30, 2017
  24. Taylor BlauOct 1, 2017
  25. 1/6 pretty.c: delimit "%(trailers)" arguments with ","Taylor Blau, Oct 1, 2017
  26. 2/6 t6300: refactor %(trailers) testsTaylor Blau, Oct 1, 2017
  27. 3/6 doc: 'trailers' is the preferred way to format trailersTaylor Blau, Oct 1, 2017
  28. 4/6 doc: use modern "`"-style code fencingTaylor Blau, Oct 1, 2017
  29. 5/6 ref-filter.c: use trailer_opts to format trailersTaylor Blau, Oct 1, 2017
  30. 6/6 ref-filter.c: parse trailers arguments with %(contents) atomTaylor Blau, Oct 1, 2017
  31. Taylor BlauOct 1, 2017
  32. 1/6 pretty.c: delimit "%(trailers)" arguments with ","Taylor Blau, Oct 1, 2017
  33. 2/6 t6300: refactor %(trailers) testsTaylor Blau, Oct 1, 2017
  34. Junio C HamanoOct 2, 2017
  35. 3/6 doc: 'trailers' is the preferred way to format trailersTaylor Blau, Oct 1, 2017
  36. 4/6 doc: use modern "`"-style code fencingTaylor Blau, Oct 1, 2017
  37. Junio C HamanoOct 1, 2017
  38. Taylor BlauOct 2, 2017
  39. Junio C HamanoOct 2, 2017
  40. Jeff KingOct 2, 2017
  41. 5/6 ref-filter.c: use trailer_opts to format trailersTaylor Blau, Oct 1, 2017
  42. Junio C HamanoOct 2, 2017
  43. 6/6 ref-filter.c: parse trailers arguments with %(contents) atomTaylor Blau, Oct 1, 2017
  44. Junio C HamanoOct 2, 2017
  45. Junio C HamanoOct 2, 2017
  46. Jeff KingOct 2, 2017
  47. Taylor BlauOct 2, 2017
  48. 1/6 pretty.c: delimit "%(trailers)" arguments with ","Taylor Blau, Oct 2, 2017
  49. 2/6 t6300: refactor %(trailers) testsTaylor Blau, Oct 2, 2017
  50. 3/6 doc: 'trailers' is the preferred way to format trailersTaylor Blau, Oct 2, 2017
  51. 5/6 ref-filter.c: use trailer_opts to format trailersTaylor Blau, Oct 2, 2017
  52. 4/6 doc: use modern "`"-style code quotingTaylor Blau, Oct 2, 2017
  53. 6/6 ref-filter.c: parse trailers arguments with %(contents) atomTaylor Blau, Oct 2, 2017
  54. Junio C HamanoOct 2, 2017
  55. Junio C HamanoOct 2, 2017
  56. Taylor BlauOct 2, 2017
  57. Jeff KingOct 2, 2017
  58. Taylor BlauOct 2, 2017
  59. Jeff KingOct 2, 2017
  60. Taylor BlauOct 2, 2017
  61. 1/7 pretty.c: delimit "%(trailers)" arguments with ","Taylor Blau, Oct 2, 2017
  62. 2/7 t4205: unfold across multiple linesTaylor Blau, Oct 2, 2017
  63. 3/7 doc: 'trailers' is the preferred way to format trailersTaylor Blau, Oct 2, 2017
  64. 4/7 doc: use modern "`"-style code quotingTaylor Blau, Oct 2, 2017
  65. 6/7 ref-filter.c: use trailer_opts to format trailersTaylor Blau, Oct 2, 2017
  66. 7/7 ref-filter.c: parse trailers arguments with %(contents) atomTaylor Blau, Oct 2, 2017
  67. Jeff KingOct 2, 2017
  68. Junio C HamanoOct 2, 2017
  69. Taylor BlauOct 2, 2017
  70. Junio C HamanoOct 2, 2017
  71. 5/7 t6300: refactor %(trailers) testsTaylor Blau, Oct 2, 2017
  72. Jeff KingOct 2, 2017
  73. Junio C HamanoOct 3, 2017
  74. Jeff KingOct 3, 2017
  75. Junio C HamanoOct 3, 2017
  76. Junio C HamanoOct 2, 2017
  77. Junio C HamanoOct 2, 2017
  78. Taylor BlauOct 2, 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.