On Thu, 18 May 2017 22:24:03 -0300 Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx> wrote: > Each text file under Documentation follows a different > format. Some doesn't even have titles! > > Change its representation to follow the adopted standard, > using ReST markups for it to be parseable by Sphinx: > > - comment the contents; > - add proper markups for titles; > - mark literal blocks as such; > - use :Author: for authorship; > - use the right markups for footnotes; > - escape some literals that would otherwise cause problems; > - fix identation and add blank lines where needed. OK, it seems good to me. Acked-by: Masami Hiramatsu <mhiramat@xxxxxxxxxx> By the way, there are some words which referes other section in this document, should it also be updated according to Sphinx format? e.g. [snip] > @@ -53,7 +59,8 @@ a post_handler, and how to use the maxactive and nmissed fields of > a kretprobe. But if you're in a hurry to start using Kprobes, you > can skip ahead to section 2. here, it refers "section 2". Thank you, -- Masami Hiramatsu <mhiramat@xxxxxxxxxx> -- 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
