On Fri, Feb 16, 2024 at 10:28:39AM +0200, Jani Nikula wrote: > On Thu, 15 Feb 2024, Vegard Nossum <vegard.nossum@xxxxxxxxxx> wrote: > > On 15/02/2024 12:50, Greg Kroah-Hartman wrote: > >> On Wed, Feb 14, 2024 at 09:37:31AM +0100, Vegard Nossum wrote: > >>> Document titles should have ==== above them as well, and then you would > >>> need to shift all the other headings in this document (i.e. all the --- > >>> should become ===). > >>> > >>> Info here: https://docs.kernel.org/doc-guide/sphinx.html#specific-guidelines-for-the-kernel-documentation > >> > >> Really? I copied this directly from > >> Documentation/process/security-bugs.rst which is in the format that I > >> used here. Which one is incorrect, I'm confused. > > > > Documentation/ currently has a mix of both formats and they both work, > > but the guidelines linked above is the gold standard and what we should > > aim for in new documents. > > > > The "correct" format would thus be: > > > > ==== > > CVEs > > ==== > > > > ... > > > > Process > > ======= > > > > ... > > > > At least this is my understanding; I'm happy to be corrected (and in > > this case, we should also update the documentation). > > rst basically allows any order of the heading underlines, and their > relative hierarchy is determined by how they show up in each document, > it's not specified by rst. However, it would be much easier for everyone > if all the kernel documents followed the same style. Agreed, someone should pick a style and sweep the whole directory and sync them up to the agreed formatting. :) thanks, greg k-h
