patchDocumentation/Notes: Remove 'footnote:' warning

Remove 'footnote:' from git-notes.txt which is responsible
for the warnings surfacing during the generation of git
documentation.
---
 Documentation/git-notes.txt |    9 +++++----
 1 files changed, 5 insertions(+), 4 deletions(-)

On Sun, 2011-07-17 at 04:00 +0530, Pavan Kumar Sunkara wrote:

What version of asciidoc are you using? Perhaps that works just fine with newer versions?

Hi,

Drew Northup wrote:

Good call.  This was fixed by Docbook XSL 1.76.0:

	Norman Walsh: block.xsl; endnotes.xsl

		Fix bug where simpara in footnote didn't work.

The symptoms are a warning and a little extra vertical space after the numberal "1." in the output. I don't know if it is worth working around or not.

On Mon, Jul 18, 2011 at 3:28 AM, Jonathan Nieder <jrnieder@gmail.com> wrote:

So, using newest version will not give us a warning?

Pavan Kumar Sunkara wrote:

Yes, when I run "make -C Documentation git-notes.1" I don't get the warning or spurious blank line. Sorry for the lack of clarity. (That's no reason to not to adopt a workaround if it is pleasant, of course.)

Currently the documentation at http://www.kernel.org/pub/software/scm/git/docs/git-notes.html is showing the footnote wrongly. This workaround will solve that. Jonathan, ack the patch if you want to have a workaround.

Thanks

Pavan Kumar Sunkara wrote:

(For reference, the linked-to page was generated with asciidoc 8.4.5 and renders the footnote as

	<br />[Permitted pathnames have the
[...]
	rest of the object ID.]<br />.

inline instead of a nicely labelled link like "[1]" that one might expect.)

Weird. That's not the Docbook XSL bug I pointed to --- the HTML documentation is generated by asciidoc directly, without any help from Docbook XSL. And I can't reproduce it locally, either. *digs around in asciidoc changelog* Ah, Asciidoc 8.5.1 introduced styling of footnotes:

     * Styled HTML footnotes.
     * Added links to HTML footnote refs.

Until the kernel.org toolchain gains that feature, wouldn't a simpler workaround be to put the footnote after the period, so it renders there as a simple line in brackets?

Barring that, it should be possible to put this information in the discussion section without disrupting the flow of the text so much, for example by putting it in parentheses or making it the last paragraph of the discussion section. A patch with such a change and mentioning in the commit message the two bugs you're working around would seem sane to me.

Thanks, Jonathan

That is what I did.

I agree. So, if the patch is ok, I will rewrite the commit msg and send it again.

Thanks, Pavan Kumar Sunkara

Pavan Kumar Sunkara <pavan.sss1991@gmail.com> writes:

Thanks.

I am using asciidoc 8.6.3. It is the newest available in ubuntu repository.

On Sun, Jul 17, 2011 at 6:41 PM, Drew Northup <drew.northup@maine.edu> wrote: