linux-kernel - Re: [PATCH 07/10] docs: RCU: RTFP: fix bibtex entries

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20200421212850.616db8b0@coco.lan>
Date:   Tue, 21 Apr 2020 21:29:06 +0200
From:   Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To:     "Paul E. McKenney" <paulmck@...nel.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        Josh Triplett <josh@...htriplett.org>,
        Steven Rostedt <rostedt@...dmis.org>,
        Mathieu Desnoyers <mathieu.desnoyers@...icios.com>,
        Lai Jiangshan <jiangshanlai@...il.com>,
        Joel Fernandes <joel@...lfernandes.org>, rcu@...r.kernel.org
Subject: Re: [PATCH 07/10] docs: RCU: RTFP: fix bibtex entries

Em Tue, 21 Apr 2020 10:52:25 -0700
"Paul E. McKenney" <paulmck@...nel.org> escreveu:

> On Tue, Apr 21, 2020 at 10:43:29AM -0700, Paul E. McKenney wrote:
> > On Tue, Apr 21, 2020 at 07:04:08PM +0200, Mauro Carvalho Chehab wrote:  
> > > There are several troubles at the bibtex entries with
> > > prevent them to be processed by LaTeX:
> > > 
> > > - On LaTeX, comment lines start with '%', but here, comments
> > >   are starting with "#";
> > > - Underlines should be escaped.
> > > - While the best would be to use \url{} for all URL entries,
> > >   let's do it at least for a couple that would otherwise
> > >   produce errors on LaTeX.
> > > 
> > > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>  
> > 
> > Another approach might be just to link to a public repo containing
> > cleaned-up versions of these bibliography entries:
> > 
> > https://git.kernel.org/pub/scm/linux/kernel/git/paulmck/perfbook.git/tree/bib/RCU.bib
> > 
> > That would have the advantage of keeping this information in only one
> > place, and reducing the number of updates required.

Yeah. I didn't know you had it somewhere else.

> > 
> > Thoughts?  
> 
> OK, I should have read the next patch in the series, where you convert
> into a Sphinx-compatible bibliography.  Except that you had to convert
> the bibtex entries by hand to produce the Sphinx-compatible entries?

No, but it still required a lot of manual work.

I manually converted the file to ReST. That was the easiest part.

Then, I used sphinx-build to convert it into a LaTeX file and changed
the produced .tex for it to use the .bib file. 

The last step was the hardest one. I'm not familiar with LaTeX. I did
several attempts to produce an output with the same kind of captions
as the original file, but I was unable to generate it.

So, I ended doing the final step the hard way: I used XeLaTeX to produce
a PDF file. Then, I manually copied the entries from the output back into 
the ReST file, carefully adjusting the captions, in order for them to
point to the right places. 

Before that, I tried to use a few Sphinx BibTeX extensions, but they
are not complete: they were unable to parse some types of entries.
If I'm not mistaken (I did it some time ago, on another computer),
the ones I tested crashed when trying to parse some entries, like 
'@...ference'.

> That will get a bit ugly when it comes time to add more entries.
> 
> Or was the conversion of bibliography entries automated?

I suspect it should be possible to automate it, but, as I said,
I'm not too familiar with LaTeX. 

Thanks,
Mauro