Re: [PATCH tip/core/rcu 1/8] documentation: Record RCU requirements
From: Paul E. McKenney
Date: Sat Dec 05 2015 - 15:19:49 EST
On Fri, Dec 04, 2015 at 05:54:31PM -0800, Paul E. McKenney wrote:
> On Fri, Dec 04, 2015 at 04:34:43PM -0800, Josh Triplett wrote:
> > The content of the document seems fine; a few comments below on
> > meta-issues.
> >
> > On Fri, Dec 04, 2015 at 03:50:19PM -0800, Paul E. McKenney wrote:
> > > --- /dev/null
> > > +++ b/Documentation/RCU/Design/Requirements/Requirements.html
> > > @@ -0,0 +1,2799 @@
> > > +<!-- DO NOT HAND EDIT. -->
> > > +<!-- Instead, edit Requirements.htmlx and run 'sh htmlqqz.sh Requirements' -->
> > > +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
> > > + "http://www.w3.org/TR/html4/loose.dtd";>
> >
> > Nit: these days, this should just be:
> > <!doctype html>
>
> Will making this change mean that https://validator.w3.org/ will
> then require me to make a huge quantity of other changes?
I checked a prominent web site, and they are using the same doctype as
I am, so I am keeping this one. However...
> > > + <html>
> > > + <head><title>A Tour Through RCU's Requirements [LWN.net]</title>
> > > + <meta HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
> >
> > Is there a good reason to not use charset=utf-8 here?
>
> Beats me. Cargo-culted that one. ;-)
... they use utf-8, so I changed mine accordingly.
> > > +
> > > +<h1>A Tour Through RCU's Requirements</h1>
> > > +
> > > +<p>Copyright IBM Corporation, 2015</p>
> >
> > If you're aiming for a properly formatted copyright notice, the year
> > typically comes first, followed by the copyright holder. That said,
> > your corporate guidelines presumably have a specific format; is this
> > that format?
>
> Indeed it is. Between you and IBM Legal, I unfortunately must follow
> IBM Legal's advice. ;-)
>
> > > +<p>Author: Paul E. McKenney</p>
> > > +<p><i>The initial version of this document appeared in the
> > > +<a href="http://lwn.net/";>LWN</a> articles
> > > +<a href="http://lwn.net/Articles/652156/";>here</a>,
> > > +<a href="http://lwn.net/Articles/652677/";>here</a>, and
> > > +<a href="http://lwn.net/Articles/653326/";>here</a>.</i></p>
> >
> > s/http/https/g
>
> Will change.
And done, globally, at least for those whose webservers were willing to
put up with the change. Which was the vast majority.
[ . . . ]
> > > +<p>
> > > +This all should be quite obvious, but the fact remains that
> > > +Linus Torvalds recently had to
> > > +<a href="http://marc.info/?l=linux-kernel&m=142905739823385";>remind</a>
> > > +me of this requirement.
> >
> > I'd suggest using the lkml.kernel.org redirector for this link, along
> > with a Message-Id.
> >
> > > +<p>
> > > +The name notwithstanding, some Linux-kernel architectures
> > > +can have nested NMIs, which RCU must handle correctly.
> > > +Andy Lutomirski
> > > +<a href="https://lkml.org/lkml/2014/11/21/642";>surprised me</a>
> > > +with this requirement;
> > > +he also kindly surprised me with
> > > +<a href="https://lkml.org/lkml/2014/11/22/1";>an algorithm</a>
> > > +that meets this requirement.
> >
> > These links should both use lkml.kernel.org as well. Doubly important
> > because lkml.org is often down or has broken messages in its archive.
>
> Good point, will look into finding the Message-IDs...
This involves a second click for https://lkml.kernel.org/r/<Message-ID>
Trying https://lkml.kernel.org/g/<Message-ID>. Which works nicely, so sold!
I will let you bug kernel.org about the fact that it translates the URL
to the http: form rather than the https: form... But if it did that for
the /g/ form, it couldn't find the web page. Never mind!
So all the ones that work have been converted.
Thanx, Paul
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/