On Tue, 18 Oct 2016, David Howells <dhowells@xxxxxxxxxx> wrote: > Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx> wrote: > >> - Fix identatio for the document title; >> - remove its index; >> - create a table for hash algorithm to be used; >> - use quote blocks where needed; >> - use monotonic fonts for parameters; >> - adjust whitespaces and blank lines; >> - Fix case on section titles; >> - add it to the user's book. > > Hmmm... I'm not entirely convinced that these changes are an improvement. The > main usage of this file is as a text file, but the index has been removed and > it's now got weird markups in it that reduce the readability. > > Can you please at least return the index? If these files are no longer meant > to be read as text files, why don't we just bite the bullet and convert the > whole lot to latex, docbook or texinfo? This is supposed to be the best of both worlds. Human readable, grepable, diffable reStructuredText source files, with the ability to generate pretty output for people who want it. That said, it's not the intention that we'd go overboard with markup, we need to maintain a balance with the readability in source vs. eye candy in the output. We're not going to latex, docbook, nor texinfo. Indeed, the goal from the start was to get rid of docbook. That part of the discussion has been long over. BR, Jani. -- Jani Nikula, Intel Open Source Technology Center -- 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
