From 6381853128bf8d533a54b25c21e28b5f165d46f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Kl=C3=B6tzke?= Date: Mon, 11 Nov 2024 20:51:58 +0100 Subject: [PATCH 1/4] Add pyproject.toml When installing Bob, sphinx-build must be available to build the manpages. There used to be a setuptools integration but that was removed upstream and consequently dropped here in 1346895a. Using the 'setup_requires' key in setup.py does not work either. Instead, add a pyproject.toml file that declares this dependency. That seems to work for current pip versions. The only drawback is that we now require Windows user to also temporarily install Sphinx during installation, even though it will not be used so far. --- pyproject.toml | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 pyproject.toml diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 00000000..cd72df0d --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["setuptools >= 40.0", "Sphinx"] +build-backend = "setuptools.build_meta" From b0421fc6355225e75a6c8d2a0cb3620f7b393dd5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Kl=C3=B6tzke?= Date: Mon, 11 Nov 2024 21:11:21 +0100 Subject: [PATCH 2/4] doc: update copyright year --- doc/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index 0c7d91e6..48147e97 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -61,7 +61,7 @@ def __getattr__(cls, name): # General information about the project. project = 'Bob' -copyright = '2016-2020, The BobBuildTool Contributors' +copyright = '2016-2024, The BobBuildTool Contributors' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the From eae55079265348c9d9ce7481bbdd183b2049dd32 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Kl=C3=B6tzke?= Date: Mon, 11 Nov 2024 21:11:55 +0100 Subject: [PATCH 3/4] doc: add bob-layers to top-level manpage --- doc/manpages/bob.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/manpages/bob.rst b/doc/manpages/bob.rst index 62385873..99a18e6f 100644 --- a/doc/manpages/bob.rst +++ b/doc/manpages/bob.rst @@ -77,7 +77,7 @@ Options User commands ------------- -The user commands are intended for interactive usage. Unless otherwise noticed +The user commands are intended for interactive usage. Unless otherwise noticed, their output is subject to improvements in future versions and usually not intended to be parsed by scripts. @@ -86,7 +86,7 @@ intended to be parsed by scripts. :ref:`manpage-build` Build (sub-)packages in release mode :ref:`manpage-clean` - Delete unused src/build/dist paths of release builds + Delete unused src/build/dist paths :ref:`manpage-dev` Build (sub-)packages in development mode :ref:`manpage-graph` @@ -97,10 +97,12 @@ bob-help Initialize build tree :ref:`manpage-bob-jenkins` Configure Jenkins server +:ref:`manpage-layers` + Update or show status of managed layers :ref:`manpage-bob-ls` List package hierarchy. The output is suitable to be used in non-interactive scripts. :ref:`manpage-bob-project` - Create project files + Create IDE project files :ref:`manpage-show` Show properties of a package :ref:`manpage-bob-status` From a3af5aa9bace4c74b0ff39121ad42cbda6d64bde Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Kl=C3=B6tzke?= Date: Mon, 11 Nov 2024 21:12:26 +0100 Subject: [PATCH 4/4] setup: install bob and bob-layers manpages --- setup.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/setup.py b/setup.py index 3e189531..62ba9138 100644 --- a/setup.py +++ b/setup.py @@ -77,12 +77,14 @@ class build(build_orig): if sys.platform != 'win32': data_files.extend([ ('share/man/man1', [ + 'doc/_build/man/bob.1', 'doc/_build/man/bob-archive.1', 'doc/_build/man/bob-build.1', 'doc/_build/man/bob-clean.1', 'doc/_build/man/bob-dev.1', 'doc/_build/man/bob-graph.1', 'doc/_build/man/bob-jenkins.1', + 'doc/_build/man/bob-layers.1', 'doc/_build/man/bob-ls.1', 'doc/_build/man/bob-project.1', 'doc/_build/man/bob-query-meta.1',