From: "brian m. carlson" <sandals@crustytoothpaste.net>
To: Thomas Gummerer <t.gummerer@gmail.com>
Cc: "Junio C Hamano" <gitster@pobox.com>,
"Jonathan Nieder" <jrnieder@gmail.com>,
git@vger.kernel.org, "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Subject: Re: [PATCH 2/1] SubmittingPatches: not git-security@googlegroups.com
Date: Tue, 29 May 2018 19:53:53 +0000 [thread overview]
Message-ID: <20180529195353.GM652292@genre.crustytoothpaste.net> (raw)
In-Reply-To: <20180529180203.GC8868@hank.intra.tgummerer.com>
[-- Attachment #1: Type: text/plain, Size: 2064 bytes --]
On Tue, May 29, 2018 at 07:02:03PM +0100, Thomas Gummerer wrote:
> On 05/28, Junio C Hamano wrote:
> > This is a tangent, but the use of footnote below looks a but
> > curious. How would {1} reference pick which :1: to use? The
> > closest preceding one?
>
> Tbh I didn't look at the docs for doing this, but just used the same
> syntax as we're already using and tried it with both asciidoc and
> asciidoctor. And yes it seems like it always picks the preceeding
> one.
Yes, I believe the attributes namespace is flat and substituted using
the current version that's defined. I wouldn't rely extensively on
that, though, so unique names are probably better.
> > As this appears on a page that already has other footnotes attached
> > to an adjacent paragraph, I am wondering if they should be made into
> > a part of the same numbering sequence.
>
> I have now actually looked at the docs, and this numbering has nothing
> to do with the footnote format, but rather is used to substitute the
> attribute that's specified in the curly braces with the text that's
> after :<attribute>: [1]. This initially confused me a bit. Maybe it
> would be nicer to give the attributes names instead of just numbers?
> As we keep adding footnotes, that would be less likely to produce
> conflicts between the different attributes I think.
> I'm also adding brian to the cc list, as he first converted this to
> AsciiDoc for opinions.
In AsciiDoc, footnotes use the named macro syntax. I thought it would
be difficult to read to have the footnotes inline, so I chose to use an
attribute to substitute them. I used numbers because we had a small
number of them and the original footnotes were numbered. I was trying
to make a minimal, faithful conversion.
I have no objection to named footnotes and I agree they're easier to use
if we have a large number of them. I think whatever we use, we should
try to make them unique, as I mentioned above.
--
brian m. carlson: Houston, Texas, US
OpenPGP: https://keybase.io/bk2204
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 867 bytes --]
next prev parent reply other threads:[~2018-05-29 19:54 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-05-27 14:04 [PATCH] README: note git-security@googlegroups.com Thomas Gummerer
2018-05-27 15:34 ` Jonathan Nieder
2018-05-27 21:08 ` [PATCH 2/1] SubmittingPatches: not git-security@googlegroups.com Thomas Gummerer
2018-05-28 3:00 ` Junio C Hamano
2018-05-29 18:02 ` Thomas Gummerer
2018-05-29 18:05 ` Thomas Gummerer
2018-05-29 19:53 ` brian m. carlson [this message]
2018-05-30 20:52 ` [PATCH v2 1/2] SubmittingPatches: replace numbered attributes with names Thomas Gummerer
2018-05-30 20:52 ` [PATCH v2 2/2] note git-security@googlegroups.com in more places Thomas Gummerer
2018-05-30 23:37 ` brian m. carlson
2018-05-31 19:22 ` Thomas Gummerer
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180529195353.GM652292@genre.crustytoothpaste.net \
--to=sandals@crustytoothpaste.net \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jrnieder@gmail.com \
--cc=t.gummerer@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).