On Thu, May 10, 2018 at 06:38:05AM -0300, Mauro Carvalho Chehab wrote: > Em Thu, 10 May 2018 01:38:38 -0700 > Christoph Hellwig <hch@xxxxxxxxxxxxx> escreveu: > > > > * Use either while holding wait_queue_head::lock or when used for wakeups > > > - * with an extra smp_mb() like: > > > + * with an extra smp_mb() like:: > > > > Independent of any philosophical discussion not allowing a setence to > > end with a single ':' is completely idiotic. Please fix the tooling > > instead to allow it, as it is very important for being able to just > > write understandable comments. That is exactly my point; the whole rst stuff detracts from normal text. It makes both reading and writing harder than it needs to be. > Patches are welcome, although I don't see any easy way to solve it. > > In English, the common case is that a line with ends with a colon is > followed by a list. E. g. (google) Dictionary says: "a punctuation mark (:) used to precede a list of items, a quotation, or an expansion or explanation." An enumeration (list) is just one of many possible uses of the colon. > However, in this specific case, it is followed by an ascii artwork. > The double colon is a notation that tells Sphinx to not parse the > lines at the next block, placing the contents of it inside a literal > block. It is used also when the next lines contain a code example, > in order to avoid parsing things like @, () and * inside the code > block. > > The kernel-doc tool might eventually have some parsing logic that > would replace something to a '::' before sending it to Sphinx. I think typically there will be an 'empty' line between the colon ending and the 'example/explanation'. This seems true for a number of comments I found in drm using the '::' nonsense. Simple regexes don't do multi-line patterns, but maybe the kerneldoc thing can parse it differently. -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
