14 Aug, 2020

1 commit

  • Pull documentation fixes from Jonathan Corbet:
    "A handful of obvious fixes that wandered in during the merge window"

    * tag 'docs-5.9-2' of git://git.lwn.net/linux:
    Documentation/locking/locktypes: fix the typo
    doc/zh_CN: resolve undefined label warning in admin-guide index
    doc/zh_CN: fix title heading markup in admin-guide cpu-load
    docs: remove the 2.6 "Upgrading I2C Drivers" guide
    docs: Correct the release date of 5.2 stable
    mailmap: Update comments for with format and more detalis
    docs: cdrom: Fix a typo and rst markup
    Doc: admin-guide: use correct legends in kernel-parameters.txt
    Documentation/features: refresh RISC-V arch support files
    documentation: coccinelle: Improve command example for make C={1,2}
    Core-api: Documentation: Replace deprecated :c:func: Usage
    Dev-tools: Documentation: Replace deprecated :c:func: Usage
    Filesystems: Documentation: Replace deprecated :c:func: Usage
    docs: trace: fix a typo

    Linus Torvalds
     

12 Aug, 2020

1 commit

  • "The capability fags" should be "The capability flags".

    In rst markup, a incorrect markup expression is causing bad rendering in
    Sphinx output. Replace the erroneous single quote by a backquote.

    Signed-off-by: Remi Andruccioli
    Link: https://lore.kernel.org/r/20200808163123.17643-1-remi.andruccioli@gmail.com
    Signed-off-by: Jonathan Corbet

    Remi Andruccioli
     

09 Jul, 2020

1 commit


15 Jul, 2019

1 commit

  • The contents of those directories were orphaned at the documentation
    body.

    While those directories could likely be moved to be inside some guide,
    I'm opting to just adding their indexes to the main one, removing the
    :orphan: and adding the SPDX header.

    For the drivers, the rationale is that the documentation contains
    a mix of Kernelspace, uAPI and admin-guide. So, better to keep them on
    separate directories, as we've be doing with similar subsystem-specific
    docs that were not split yet.

    For the others, well... I'm too lazy to do the move. Also, it
    seems to make sense to keep at least some of those at the main
    dir (like kbuild, for example). In any case, a latter patch
    could do the move.

    Signed-off-by: Mauro Carvalho Chehab
    Acked-by: Bartlomiej Zolnierkiewicz

    Mauro Carvalho Chehab
     

15 Jun, 2019

3 commits

  • The conversion is actually:
    - add blank lines and identation in order to identify paragraphs;
    - fix tables markups;
    - add some lists markups;
    - mark literal blocks;
    - adjust title markups.

    At its new index.rst, let's add a :orphan: while this is not linked to
    the main index.rst file, in order to avoid build warnings.

    Signed-off-by: Mauro Carvalho Chehab
    Acked-by: Geert Uytterhoeven
    Signed-off-by: Jonathan Corbet

    Mauro Carvalho Chehab
     
  • The stuff there is almost already at ReST format. A
    conversion for them is trivial: just add a missing titles
    and fix some scape codes for them to match ReST syntax.

    While here, rename the cdrom-standard.txt, with was converted
    from LaTeX to ReST on the previous patch, and add it to the
    index file.

    At its new index.rst, let's add a :orphan: while this is not linked to
    the main index.rst file, in order to avoid build warnings.

    Signed-off-by: Mauro Carvalho Chehab
    Signed-off-by: Jonathan Corbet

    Mauro Carvalho Chehab
     
  • This is the only LaTeX documentation file inside the documentation.

    Instead of having a Latex document directly there, convert
    it to ReST format, as this is the format we're using for docs.

    For now, let's keep the extension as .txt in order to avoid
    warnings when building the documentation with Sphinx.

    The next patch patch will rename it to .rst and add it to the
    building system.

    Signed-off-by: Mauro Carvalho Chehab
    Signed-off-by: Jonathan Corbet

    Mauro Carvalho Chehab
     

10 Sep, 2018

1 commit

  • This is a respin with a wider audience (all that get_maintainer returned)
    and I know this spams a *lot* of people. Not sure what would be the correct
    way, so my apologies for ruining your inbox.

    The 00-INDEX files are supposed to give a summary of all files present
    in a directory, but these files are horribly out of date and their
    usefulness is brought into question. Often a simple "ls" would reveal
    the same information as the filenames are generally quite descriptive as
    a short introduction to what the file covers (it should not surprise
    anyone what Documentation/sched/sched-design-CFS.txt covers)

    A few years back it was mentioned that these files were no longer really
    needed, and they have since then grown further out of date, so perhaps
    it is time to just throw them out.

    A short status yields the following _outdated_ 00-INDEX files, first
    counter is files listed in 00-INDEX but missing in the directory, last
    is files present but not listed in 00-INDEX.

    List of outdated 00-INDEX:
    Documentation: (4/10)
    Documentation/sysctl: (0/1)
    Documentation/timers: (1/0)
    Documentation/blockdev: (3/1)
    Documentation/w1/slaves: (0/1)
    Documentation/locking: (0/1)
    Documentation/devicetree: (0/5)
    Documentation/power: (1/1)
    Documentation/powerpc: (0/5)
    Documentation/arm: (1/0)
    Documentation/x86: (0/9)
    Documentation/x86/x86_64: (1/1)
    Documentation/scsi: (4/4)
    Documentation/filesystems: (2/9)
    Documentation/filesystems/nfs: (0/2)
    Documentation/cgroup-v1: (0/2)
    Documentation/kbuild: (0/4)
    Documentation/spi: (1/0)
    Documentation/virtual/kvm: (1/0)
    Documentation/scheduler: (0/2)
    Documentation/fb: (0/1)
    Documentation/block: (0/1)
    Documentation/networking: (6/37)
    Documentation/vm: (1/3)

    Then there are 364 subdirectories in Documentation/ with several files that
    are missing 00-INDEX alltogether (and another 120 with a single file and no
    00-INDEX).

    I don't really have an opinion to whether or not we /should/ have 00-INDEX,
    but the above 00-INDEX should either be removed or be kept up to date. If
    we should keep the files, I can try to keep them updated, but I rather not
    if we just want to delete them anyway.

    As a starting point, remove all index-files and references to 00-INDEX and
    see where the discussion is going.

    Signed-off-by: Henrik Austad
    Acked-by: "Paul E. McKenney"
    Just-do-it-by: Steven Rostedt
    Reviewed-by: Jens Axboe
    Acked-by: Paul Moore
    Acked-by: Greg Kroah-Hartman
    Acked-by: Mark Brown
    Acked-by: Mike Rapoport
    Cc: [Almost everybody else]
    Signed-off-by: Jonathan Corbet

    Henrik Austad
     

09 Mar, 2018

2 commits

  • Apparently the LaTex abbreviation for the German "sharp s" (ß)
    (Unicode U+00DF) has changed from {\sz} to {\ss}. With {\sz},
    I get this error at line 1016 (line number after another patch):

    ! Undefined control sequence.
    l.1016 ...nel~2.0. Further thanks to Heiko Ei{\sz
    }feldt,

    This is fixed by changing the {\sz} to {\ss}.

    Signed-off-by: Randy Dunlap
    Signed-off-by: Jens Axboe

    Randy Dunlap
     
  • Documentation updates for Documentation/cdrom/cdrom-standard.tex:

    cdrom_device_ops:
    - add check_events() and generic_packet()

    cdrom_device_info:
    - add one 'const' modifier
    - correct some field descriptions
    - add some missing fields
    - drop 'kdev_t dev;' field

    Also drop sentence from documentation because it is not
    referenced anywhere in the kernel header or C files.

    Signed-off-by: Randy Dunlap
    Signed-off-by: Jens Axboe

    Randy Dunlap
     

13 Oct, 2017

1 commit


14 Feb, 2017

1 commit

  • Since function tables are a common target for attackers, it's best to keep
    them in read-only memory. As such, this makes the CDROM device ops tables
    const. This drops additionally n_minors, since it isn't used meaningfully,
    and sets the only user of cdrom_dummy_generic_packet explicitly so the
    variables can all be const.

    Inspired by similar changes in grsecurity/PaX.

    Signed-off-by: Kees Cook
    Acked-by: David S. Miller
    Signed-off-by: Jens Axboe

    Kees Cook