17 Jul, 2019

5 commits


27 Jun, 2019

1 commit

  • Build of htmldocs fails for out-of-tree builds:

    $ make V=1 O=~/build/kernel/ htmldocs
    make -C /home/rppt/build/kernel -f /home/rppt/git/linux-docs/Makefile htmldocs
    make[1]: Entering directory '/home/rppt/build/kernel'
    make -f /home/rppt/git/linux-docs/scripts/Makefile.build obj=scripts/basic
    rm -f .tmp_quiet_recordmcount
    make -f /home/rppt/git/linux-docs/scripts/Makefile.build obj=Documentation htmldocs
    Can't open Documentation/conf.py at /home/rppt/git/linux-docs/scripts/sphinx-pre-install line 230.
    /home/rppt/git/linux-docs/Documentation/Makefile:80: recipe for target 'htmldocs' failed
    make[2]: *** [htmldocs] Error 2

    The scripts/sphinx-pre-install is trying to open files in the current
    directory which is $KBUILD_OUTPUT rather than in $srctree.

    Fix it.

    Signed-off-by: Mike Rapoport
    Reviewed-by: Mauro Carvalho Chehab
    Signed-off-by: Jonathan Corbet

    Mike Rapoport
     

15 Jun, 2019

1 commit


08 Jun, 2019

1 commit


31 May, 2019

5 commits

  • Pull yet more SPDX updates from Greg KH:
    "Here is another set of reviewed patches that adds SPDX tags to
    different kernel files, based on a set of rules that are being used to
    parse the comments to try to determine that the license of the file is
    "GPL-2.0-or-later" or "GPL-2.0-only". Only the "obvious" versions of
    these matches are included here, a number of "non-obvious" variants of
    text have been found but those have been postponed for later review
    and analysis.

    There is also a patch in here to add the proper SPDX header to a bunch
    of Kbuild files that we have missed in the past due to new files being
    added and forgetting that Kbuild uses two different file names for
    Makefiles. This issue was reported by the Kbuild maintainer.

    These patches have been out for review on the linux-spdx@vger mailing
    list, and while they were created by automatic tools, they were
    hand-verified by a bunch of different people, all whom names are on
    the patches are reviewers"

    * tag 'spdx-5.2-rc3-1' of git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/driver-core: (82 commits)
    treewide: Add SPDX license identifier - Kbuild
    treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 225
    treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 224
    treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 223
    treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 222
    treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 221
    treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 220
    treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 218
    treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 217
    treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 216
    treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 215
    treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 214
    treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 213
    treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 211
    treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 210
    treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 209
    treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 207
    treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 206
    treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 203
    treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 201
    ...

    Linus Torvalds
     
  • Based on 3 normalized pattern(s):

    this program is free software you can redistribute it and or modify
    it under the terms of the gnu general public license as published by
    the free software foundation either version 2 of the license or at
    your option any later version this program is distributed in the
    hope that it will be useful but without any warranty without even
    the implied warranty of merchantability or fitness for a particular
    purpose see the gnu general public license for more details

    this program is free software you can redistribute it and or modify
    it under the terms of the gnu general public license as published by
    the free software foundation either version 2 of the license or at
    your option any later version [author] [kishon] [vijay] [abraham]
    [i] [kishon]@[ti] [com] this program is distributed in the hope that
    it will be useful but without any warranty without even the implied
    warranty of merchantability or fitness for a particular purpose see
    the gnu general public license for more details

    this program is free software you can redistribute it and or modify
    it under the terms of the gnu general public license as published by
    the free software foundation either version 2 of the license or at
    your option any later version [author] [graeme] [gregory]
    [gg]@[slimlogic] [co] [uk] [author] [kishon] [vijay] [abraham] [i]
    [kishon]@[ti] [com] [based] [on] [twl6030]_[usb] [c] [author] [hema]
    [hk] [hemahk]@[ti] [com] this program is distributed in the hope
    that it will be useful but without any warranty without even the
    implied warranty of merchantability or fitness for a particular
    purpose see the gnu general public license for more details

    extracted by the scancode license scanner the SPDX license identifier

    GPL-2.0-or-later

    has been chosen to replace the boilerplate/reference in 1105 file(s).

    Signed-off-by: Thomas Gleixner
    Reviewed-by: Allison Randal
    Reviewed-by: Richard Fontana
    Reviewed-by: Kate Stewart
    Cc: linux-spdx@vger.kernel.org
    Link: https://lkml.kernel.org/r/20190527070033.202006027@linutronix.de
    Signed-off-by: Greg Kroah-Hartman

    Thomas Gleixner
     
  • Call the script every time a make docs target is selected, on
    a simplified check mode.

    With this change, the script will set two vars:

    $min_version - obtained from `needs_sphinx` var inside
    conf.py (currently, '1.3')

    $rec_version - obtained from sphinx/requirements.txt.

    With those changes, a target like "make htmldocs" will do:

    1) If no sphinx-build/sphinx-build3 is found, it will run
    the script on normal mode as before, checking for all
    system dependencies and providing install hints for the
    needed programs and will abort the build;

    2) If no sphinx-build/sphinx-build3 is found, but there is
    a sphinx_${VER}/bin/activate file, and if
    ${VER} >= $min_version (string comparation), it will
    run in full mode, and will recommend to activate the
    virtualenv. If there are multiple virtualenvs, it
    will string sort the versions, recommending the
    highest version and will abort the build;

    3) If Sphinx is detected but has a version lower than
    $min_version, it will run in full mode - with will
    recommend creating a virtual env using sphinx/requirements.txt,
    and will abort the build.

    4) If Sphinx is detected and version is lower than
    $rec_version, it will run in full mode and will
    recommend creating a virtual env using sphinx/requirements.txt.

    In this case, it **won't** abort the build.

    5) If Sphinx is detected and version is equal or righer than
    $rec_version it will return just after detecting the
    version ("quick mode"), not checking if are there any
    missing dependencies.

    Just like before, if one wants to install Sphinx from the
    distro, it has to call the script manually and use `--no-virtualenv`
    argument to get the hints for his OS:

    You should run:

    sudo dnf install -y python3-sphinx python3-sphinx_rtd_theme

    While here, add a small help for the three optional arguments
    for the script.

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

    Mauro Carvalho Chehab
     
  • RHEL8 was already launched. This test won't get it, and will
    do the wrong thing. Ok, we could fix it, but now we check
    Sphinx version to ensure that it matches the minimal (1.3),
    so there's no need for an explicit check there.

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

    Mauro Carvalho Chehab
     
  • It is possible that multiple Sphinx virtualenvs are installed
    on a given kernel tree. Change the logic to get the latest
    version of those, as this is probably what the user wants.

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

    Mauro Carvalho Chehab
     

24 May, 2019

1 commit


02 Apr, 2019

1 commit


09 Sep, 2017

1 commit

  • Only the media PDF book was requiring adjustbox, in order to
    scale big tables. That worked pretty good with Sphinx versions
    1.4 and 1.5, but Spinx 1.6 changed the way tables are produced,
    by introducing some weird macros before tabulary.
    That causes adjustbox to fail. So, it can't be used anymore,
    and its usage was removed from the media book.

    So, let's remove it from conf.py and sphinx-pre-install.

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

    Mauro Carvalho Chehab
     

08 Aug, 2017

1 commit

  • RHEL 7.x and clone distros are shipped with Sphinx 1.1.x,
    with is incompatible with Kernel ReST markups.

    So, on those systems, the only alternative is to install
    it via a Python virtual environment.

    While seeking for "pip" on CentOS 7.3, I noticed that it
    is not really needed, as python-virtualenv has its version
    packaged there already. So, remove this from the list of
    requirements for all distributions.

    With regards to PDF, we need at least texlive-tabulary
    extension, but that is not shipped there (at least on
    CentOS). So, disable PDF packages as a whole.

    Please notice, however, that texlive + amsmath is needed for
    ReST to properly handle ReST ".. math::" tags. Yet, Sphinx
    fall back to display the LaTeX math expressions as-is, if
    such extension is not available.

    So, let's just disable all texlive packages as a whole.

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

    Mauro Carvalho Chehab
     

24 Jul, 2017

7 commits