doc: add ability to disambiguate clicmds #14509

qlyoung · 2023-09-29T00:30:57Z

Multiple daemons have the same CLI commands defined, but the current directive used to document CLI commands only takes the command definition string. Since CLI command objects can be cross-referenced using the :clicmd: directive, and are placed in the index, each object needs to be unique.

To accomplish this, add a custom directive. This directive extends the directive class used by sphinx's add_object_type to add a :daemon: option. By specifying this option where needed, the object name becomes "() ", disambiguating it.

tl;dr

.. clicmd:: foo bar
   :daemon: zebra

<later>

.. clicmd:: foo bar
   :daemon: bgpd

Fixes WARNING: duplicate clicmd description of foo bar, other instance in bgpd type warnings; once all of these are resolved, there should be zero doc build warnings and we can add clean doc builds to the required test suite

Fixes #14489

NetDEF-CI · 2023-09-29T00:53:48Z

Continuous Integration Result: FAILED

Test incomplete. See below for issues.
CI System Testrun URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/

This is a comment from an automated CI system.
For questions and feedback in regards to this CI system, please feel free to email
Martin Winter - mwinter (at) opensourcerouting.org.

Get source / Pull Request: Successful

Building Stage: Incomplete

Ubuntu 18.04 arm8 build: Failed (click for details)

Make failed for Ubuntu 18.04 arm8 build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/U18ARM8BUILD/ErrorLog/log_make.txt)

make  all-am
make[1]: Entering directory '/home/ci/cibuild.14397/frr-source'
Extension error:
when adding directive classes, no additional arguments may be given
Makefile:15307: recipe for target 'doc/user/_build/.doctrees/environment.pickle' failed
make[1]: *** [doc/user/_build/.doctrees/environment.pickle] Error 1
make[1]: Target 'all-am' not remade because of errors.
make[1]: Leaving directory '/home/ci/cibuild.14397/frr-source'
Makefile:5781: recipe for target 'all' failed

Ubuntu 18.04 arm8 build: Unknown Log <config.log.gz>
URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/U18ARM8BUILD/config.log/config.log.gz
Ubuntu 18.04 arm8 build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/U18ARM8BUILD/config.status/config.status

Debian 9 amd64 build: Failed (click for details)

Debian 9 amd64 build: Unknown Log URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/CI021BUILD/config.log/config.log.gz Debian 9 amd64 build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/CI021BUILD/config.status/config.status

Make failed for Debian 9 amd64 build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/CI021BUILD/ErrorLog/log_make.txt)

make  all-am
make[1]: Entering directory '/home/ci/cibuild.14397/frr-source'
Configuration error:
There is a syntax error in your configuration file: bad input (conf.py, line 401)
Did you change the syntax from 2.x to 3.x?
Makefile:15307: recipe for target 'doc/user/_build/.doctrees/environment.pickle' failed
make[1]: *** [doc/user/_build/.doctrees/environment.pickle] Error 1
make[1]: Leaving directory '/home/ci/cibuild.14397/frr-source'
make[1]: Target 'all-am' not remade because of errors.

Ubuntu 18.04 ppc64le build: Failed (click for details)

Ubuntu 18.04 ppc64le build: Unknown Log URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/U1804PPC64LEBUILD/config.log/config.log.gz Ubuntu 18.04 ppc64le build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/U1804PPC64LEBUILD/config.status/config.status

Make failed for Ubuntu 18.04 ppc64le build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/U1804PPC64LEBUILD/ErrorLog/log_make.txt)

make  all-am
make[1]: Entering directory '/home/ci/cibuild.14397/frr-source'
Extension error:
when adding directive classes, no additional arguments may be given
Makefile:15307: recipe for target 'doc/user/_build/.doctrees/environment.pickle' failed
make[1]: *** [doc/user/_build/.doctrees/environment.pickle] Error 1
make[1]: Target 'all-am' not remade because of errors.
make[1]: Leaving directory '/home/ci/cibuild.14397/frr-source'
Makefile:5781: recipe for target 'all' failed

Ubuntu 18.04 arm7 build: Failed (click for details)

Ubuntu 18.04 arm7 build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/U18ARM7BUILD/config.status/config.status Ubuntu 18.04 arm7 build: Unknown Log URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/U18ARM7BUILD/config.log/config.log.gz

Make failed for Ubuntu 18.04 arm7 build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/U18ARM7BUILD/ErrorLog/log_make.txt)

make  all-am
make[1]: Entering directory '/home/ci/cibuild.14397/frr-source'
Extension error:
when adding directive classes, no additional arguments may be given
Makefile:15307: recipe for target 'doc/user/_build/.doctrees/environment.pickle' failed
make[1]: *** [doc/user/_build/.doctrees/environment.pickle] Error 1
make[1]: Target 'all-am' not remade because of errors.
make[1]: Leaving directory '/home/ci/cibuild.14397/frr-source'
Makefile:5781: recipe for target 'all' failed

CentOS 7 amd64 build: Failed (click for details)

CentOS 7 amd64 build: Unknown Log URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/CI005BUILD/config.log/config.log.gz CentOS 7 amd64 build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/CI005BUILD/config.status/config.status

Make failed for CentOS 7 amd64 build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/CI005BUILD/ErrorLog/log_make.txt)

pimd/pim_cmd_common.c:4899:2: warning: missing braces around initializer [-Wmissing-braces]
pimd/pim_cmd_common.c:4899:2: warning: (near initialization for sg.grp) [-Wmissing-braces]
Extension error:
when adding directive classes, no additional arguments may be given
make[1]: *** [doc/user/_build/.doctrees/environment.pickle] Error 1
deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.  CC       bgpd/bgp_addpath.o
bgpd/bgp_clist.c: In function ecommunity_list_match_delete:
bgpd/bgp_clist.c:983:9: warning: missing braces around initializer [-Wmissing-braces]
bgpd/bgp_clist.c:983:9: warning: (near initialization for local_eval.val) [-Wmissing-braces]

Debian 11 amd64 build: Incomplete

(check logs for details)

Ubuntu 18.04 amd64 build: Failed (click for details)

Ubuntu 18.04 amd64 build: Unknown Log URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/U1804AMD64/config.log/config.log.gz Ubuntu 18.04 amd64 build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/U1804AMD64/config.status/config.status

Make failed for Ubuntu 18.04 amd64 build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/U1804AMD64/ErrorLog/log_make.txt)

make  all-am
make[1]: Entering directory '/home/ci/cibuild.14397/frr-source'
Extension error:
when adding directive classes, no additional arguments may be given
Makefile:15307: recipe for target 'doc/user/_build/.doctrees/environment.pickle' failed
make[1]: *** [doc/user/_build/.doctrees/environment.pickle] Error 1
make[1]: Leaving directory '/home/ci/cibuild.14397/frr-source'
Makefile:5781: recipe for target 'all' failed
make[1]: Target 'all-am' not remade because of errors.

FreeBSD 12 amd64 build: Failed (click for details)

FreeBSD 12 amd64 build: Unknown Log URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/FBSD12AMD64/config.log/config.log.gz FreeBSD 12 amd64 build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/FBSD12AMD64/config.status/config.status

Make failed for FreeBSD 12 amd64 build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/FBSD12AMD64/ErrorLog/log_make.txt)

gmake  all-am
gmake[1]: Entering directory '/usr/home/ci/cibuild.14397/frr-source'
Extension error:
when adding directive classes, no additional arguments may be given
gmake[1]: *** [Makefile:17927: doc/user/_build/.doctrees/environment.pickle] Error 1
gmake[1]: Leaving directory '/usr/home/ci/cibuild.14397/frr-source'
gmake[1]: Target 'all-am' not remade because of errors.
gmake: *** [Makefile:6469: all] Error 2

Ubuntu 18.04 i386 build: Failed (click for details)

Make failed for Ubuntu 18.04 i386 build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/U18I386BUILD/ErrorLog/log_make.txt)

make  all-am
make[1]: Entering directory '/home/ci/cibuild.14397/frr-source'
Extension error:
when adding directive classes, no additional arguments may be given
Makefile:15307: recipe for target 'doc/user/_build/.doctrees/environment.pickle' failed
make[1]: *** [doc/user/_build/.doctrees/environment.pickle] Error 1
make[1]: Leaving directory '/home/ci/cibuild.14397/frr-source'
make[1]: Target 'all-am' not remade because of errors.
Makefile:5781: recipe for target 'all' failed

Ubuntu 18.04 i386 build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/U18I386BUILD/config.status/config.status
Ubuntu 18.04 i386 build: Unknown Log <config.log.gz>
URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/U18I386BUILD/config.log/config.log.gz

Redhat 8 amd64 build: Failed (click for details)

Redhat 8 amd64 build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/REDHAT8/config.status/config.status

Make failed for Redhat 8 amd64 build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/REDHAT8/ErrorLog/log_make.txt)

make  all-am
make[1]: Entering directory '/home/ci/cibuild.14397/frr-source'
Extension error:
when adding directive classes, no additional arguments may be given
make[1]: *** [Makefile:17927: doc/user/_build/.doctrees/environment.pickle] Error 2
make[1]: Leaving directory '/home/ci/cibuild.14397/frr-source'
make[1]: Target 'all-am' not remade because of errors.
make: *** [Makefile:6469: all] Error 2

Redhat 8 amd64 build: Unknown Log <config.log.gz>
URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14397/artifact/REDHAT8/config.log/config.log.gz

Successful on other platforms/tests

Ubuntu 22.04 amd64 build
Ubuntu 20.04 amd64 build
Debian 10 amd64 build
FreeBSD 11 amd64 build
Redhat 9 amd64 build
OpenBSD 7 amd64 build

### Basic Tests: Incomplete

NetDEF-CI · 2023-09-29T00:57:10Z

Continuous Integration Result: FAILED

Test incomplete. See below for issues.
CI System Testrun URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/

This is a comment from an automated CI system.
For questions and feedback in regards to this CI system, please feel free to email
Martin Winter - mwinter (at) opensourcerouting.org.

Get source / Pull Request: Successful

Building Stage: Incomplete

Debian 9 amd64 build: Failed (click for details)

Debian 9 amd64 build: Unknown Log URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/CI021BUILD/config.log/config.log.gz Debian 9 amd64 build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/CI021BUILD/config.status/config.status

Make failed for Debian 9 amd64 build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/CI021BUILD/ErrorLog/log_make.txt)

make  all-am
make[1]: Entering directory '/home/ci/cibuild.14398/frr-source'
Configuration error:
There is a syntax error in your configuration file: bad input (conf.py, line 402)
Did you change the syntax from 2.x to 3.x?
Makefile:15307: recipe for target 'doc/user/_build/.doctrees/environment.pickle' failed
make[1]: *** [doc/user/_build/.doctrees/environment.pickle] Error 1
make[1]: Leaving directory '/home/ci/cibuild.14398/frr-source'
make[1]: Target 'all-am' not remade because of errors.

Ubuntu 18.04 arm8 build: Failed (click for details)

Make failed for Ubuntu 18.04 arm8 build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U18ARM8BUILD/ErrorLog/log_make.txt)

make  all-am
make[1]: Entering directory '/home/ci/cibuild.14398/frr-source'
Extension error:
when adding directive classes, no additional arguments may be given
Makefile:15307: recipe for target 'doc/user/_build/.doctrees/environment.pickle' failed
make[1]: *** [doc/user/_build/.doctrees/environment.pickle] Error 1
make[1]: Target 'all-am' not remade because of errors.
make[1]: Leaving directory '/home/ci/cibuild.14398/frr-source'
Makefile:5781: recipe for target 'all' failed

Ubuntu 18.04 arm8 build: Unknown Log <config.log.gz>
URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U18ARM8BUILD/config.log/config.log.gz
Ubuntu 18.04 arm8 build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U18ARM8BUILD/config.status/config.status

Ubuntu 18.04 ppc64le build: Failed (click for details)

Ubuntu 18.04 ppc64le build: Unknown Log URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U1804PPC64LEBUILD/config.log/config.log.gz Ubuntu 18.04 ppc64le build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U1804PPC64LEBUILD/config.status/config.status

Make failed for Ubuntu 18.04 ppc64le build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U1804PPC64LEBUILD/ErrorLog/log_make.txt)

make  all-am
make[1]: Entering directory '/home/ci/cibuild.14398/frr-source'
Extension error:
when adding directive classes, no additional arguments may be given
Makefile:15307: recipe for target 'doc/user/_build/.doctrees/environment.pickle' failed
make[1]: *** [doc/user/_build/.doctrees/environment.pickle] Error 1
make[1]: Leaving directory '/home/ci/cibuild.14398/frr-source'
make[1]: Target 'all-am' not remade because of errors.
Makefile:5781: recipe for target 'all' failed

Ubuntu 18.04 arm7 build: Failed (click for details)

Ubuntu 18.04 arm7 build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U18ARM7BUILD/config.status/config.status Ubuntu 18.04 arm7 build: Unknown Log URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U18ARM7BUILD/config.log/config.log.gz

Make failed for Ubuntu 18.04 arm7 build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U18ARM7BUILD/ErrorLog/log_make.txt)

make  all-am
make[1]: Entering directory '/home/ci/cibuild.14398/frr-source'
Extension error:
when adding directive classes, no additional arguments may be given
Makefile:15307: recipe for target 'doc/user/_build/.doctrees/environment.pickle' failed
make[1]: *** [doc/user/_build/.doctrees/environment.pickle] Error 1
make[1]: Target 'all-am' not remade because of errors.
make[1]: Leaving directory '/home/ci/cibuild.14398/frr-source'
Makefile:5781: recipe for target 'all' failed

CentOS 7 amd64 build: Failed (click for details)

CentOS 7 amd64 build: Unknown Log URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/CI005BUILD/config.log/config.log.gz CentOS 7 amd64 build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/CI005BUILD/config.status/config.status

Make failed for CentOS 7 amd64 build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/CI005BUILD/ErrorLog/log_make.txt)

pimd/pim_cmd_common.c:4899:2: warning: missing braces around initializer [-Wmissing-braces]
pimd/pim_cmd_common.c:4899:2: warning: (near initialization for sg.grp) [-Wmissing-braces]
Extension error:
when adding directive classes, no additional arguments may be given
make[1]: *** [doc/user/_build/.doctrees/environment.pickle] Error 1
deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.  CC       bgpd/bgp_advertise.o
bgpd/bgp_clist.c: In function ecommunity_list_match_delete:
bgpd/bgp_clist.c:983:9: warning: missing braces around initializer [-Wmissing-braces]
bgpd/bgp_clist.c:983:9: warning: (near initialization for local_eval.val) [-Wmissing-braces]

Ubuntu 18.04 amd64 build: Failed (click for details)

Ubuntu 18.04 amd64 build: Unknown Log URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U1804AMD64/config.log/config.log.gz Ubuntu 18.04 amd64 build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U1804AMD64/config.status/config.status

Make failed for Ubuntu 18.04 amd64 build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U1804AMD64/ErrorLog/log_make.txt)

make  all-am
make[1]: Entering directory '/home/ci/cibuild.14398/frr-source'
Extension error:
when adding directive classes, no additional arguments may be given
Makefile:15307: recipe for target 'doc/user/_build/.doctrees/environment.pickle' failed
make[1]: *** [doc/user/_build/.doctrees/environment.pickle] Error 1
make[1]: Leaving directory '/home/ci/cibuild.14398/frr-source'
make[1]: Target 'all-am' not remade because of errors.
Makefile:5781: recipe for target 'all' failed

FreeBSD 12 amd64 build: Failed (click for details)

FreeBSD 12 amd64 build: Unknown Log URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/FBSD12AMD64/config.log/config.log.gz FreeBSD 12 amd64 build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/FBSD12AMD64/config.status/config.status

Make failed for FreeBSD 12 amd64 build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/FBSD12AMD64/ErrorLog/log_make.txt)

gmake  all-am
gmake[1]: Entering directory '/usr/home/ci/cibuild.14398/frr-source'
Extension error:
when adding directive classes, no additional arguments may be given
gmake[1]: *** [Makefile:17927: doc/user/_build/.doctrees/environment.pickle] Error 1
gmake[1]: Leaving directory '/usr/home/ci/cibuild.14398/frr-source'
gmake[1]: Target 'all-am' not remade because of errors.
gmake: *** [Makefile:6469: all] Error 2

Redhat 8 amd64 build: Incomplete

(check logs for details)

Ubuntu 18.04 i386 build: Failed (click for details)

Make failed for Ubuntu 18.04 i386 build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U18I386BUILD/ErrorLog/log_make.txt)

make  all-am
make[1]: Entering directory '/home/ci/cibuild.14398/frr-source'
Extension error:
when adding directive classes, no additional arguments may be given
Makefile:15307: recipe for target 'doc/user/_build/.doctrees/environment.pickle' failed
make[1]: *** [doc/user/_build/.doctrees/environment.pickle] Error 1
make[1]: Leaving directory '/home/ci/cibuild.14398/frr-source'
make[1]: Target 'all-am' not remade because of errors.
Makefile:5781: recipe for target 'all' failed

Ubuntu 18.04 i386 build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U18I386BUILD/config.status/config.status
Ubuntu 18.04 i386 build: Unknown Log <config.log.gz>
URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U18I386BUILD/config.log/config.log.gz

Successful on other platforms/tests

Ubuntu 20.04 amd64 build
Ubuntu 22.04 amd64 build
Debian 10 amd64 build
FreeBSD 11 amd64 build
Redhat 9 amd64 build
Debian 11 amd64 build
OpenBSD 7 amd64 build

### Basic Tests: Incomplete

NetDEF-CI · 2023-10-09T03:08:56Z

Continuous Integration Result: FAILED

See below for issues.
CI System Testrun URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/

This is a comment from an automated CI system.
For questions and feedback in regards to this CI system, please feel free to email
Martin Winter - mwinter (at) opensourcerouting.org.

Get source / Pull Request: Successful

Building Stage: Failed

Debian 9 amd64 build: Failed (click for details)

Debian 9 amd64 build: Unknown Log URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/CI021BUILD/config.log/config.log.gz Debian 9 amd64 build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/CI021BUILD/config.status/config.status

Make failed for Debian 9 amd64 build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/CI021BUILD/ErrorLog/log_make.txt)

make  all-am
make[1]: Entering directory '/home/ci/cibuild.14398/frr-source'
Configuration error:
There is a syntax error in your configuration file: bad input (conf.py, line 402)
Did you change the syntax from 2.x to 3.x?
Makefile:15307: recipe for target 'doc/user/_build/.doctrees/environment.pickle' failed
make[1]: *** [doc/user/_build/.doctrees/environment.pickle] Error 1
make[1]: Leaving directory '/home/ci/cibuild.14398/frr-source'
make[1]: Target 'all-am' not remade because of errors.

Ubuntu 18.04 arm8 build: Failed (click for details)

Make failed for Ubuntu 18.04 arm8 build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U18ARM8BUILD/ErrorLog/log_make.txt)

make  all-am
make[1]: Entering directory '/home/ci/cibuild.14398/frr-source'
Extension error:
when adding directive classes, no additional arguments may be given
Makefile:15307: recipe for target 'doc/user/_build/.doctrees/environment.pickle' failed
make[1]: *** [doc/user/_build/.doctrees/environment.pickle] Error 1
make[1]: Target 'all-am' not remade because of errors.
make[1]: Leaving directory '/home/ci/cibuild.14398/frr-source'
Makefile:5781: recipe for target 'all' failed

Ubuntu 18.04 arm8 build: Unknown Log <config.log.gz>
URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U18ARM8BUILD/config.log/config.log.gz
Ubuntu 18.04 arm8 build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U18ARM8BUILD/config.status/config.status

Ubuntu 18.04 ppc64le build: Failed (click for details)

Ubuntu 18.04 ppc64le build: Unknown Log URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U1804PPC64LEBUILD/config.log/config.log.gz Ubuntu 18.04 ppc64le build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U1804PPC64LEBUILD/config.status/config.status

Make failed for Ubuntu 18.04 ppc64le build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U1804PPC64LEBUILD/ErrorLog/log_make.txt)

make  all-am
make[1]: Entering directory '/home/ci/cibuild.14398/frr-source'
Extension error:
when adding directive classes, no additional arguments may be given
Makefile:15307: recipe for target 'doc/user/_build/.doctrees/environment.pickle' failed
make[1]: *** [doc/user/_build/.doctrees/environment.pickle] Error 1
make[1]: Leaving directory '/home/ci/cibuild.14398/frr-source'
make[1]: Target 'all-am' not remade because of errors.
Makefile:5781: recipe for target 'all' failed

Ubuntu 18.04 arm7 build: Failed (click for details)

Ubuntu 18.04 arm7 build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U18ARM7BUILD/config.status/config.status Ubuntu 18.04 arm7 build: Unknown Log URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U18ARM7BUILD/config.log/config.log.gz

Make failed for Ubuntu 18.04 arm7 build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U18ARM7BUILD/ErrorLog/log_make.txt)

make  all-am
make[1]: Entering directory '/home/ci/cibuild.14398/frr-source'
Extension error:
when adding directive classes, no additional arguments may be given
Makefile:15307: recipe for target 'doc/user/_build/.doctrees/environment.pickle' failed
make[1]: *** [doc/user/_build/.doctrees/environment.pickle] Error 1
make[1]: Target 'all-am' not remade because of errors.
make[1]: Leaving directory '/home/ci/cibuild.14398/frr-source'
Makefile:5781: recipe for target 'all' failed

CentOS 7 amd64 build: Failed (click for details)

CentOS 7 amd64 build: Unknown Log URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/CI005BUILD/config.log/config.log.gz CentOS 7 amd64 build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/CI005BUILD/config.status/config.status

Make failed for CentOS 7 amd64 build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/CI005BUILD/ErrorLog/log_make.txt)

pimd/pim_cmd_common.c:4899:2: warning: missing braces around initializer [-Wmissing-braces]
pimd/pim_cmd_common.c:4899:2: warning: (near initialization for sg.grp) [-Wmissing-braces]
Extension error:
when adding directive classes, no additional arguments may be given
make[1]: *** [doc/user/_build/.doctrees/environment.pickle] Error 1
deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.deprecation warning: io.FileInput() argument `handle_io_errors` is ignored since "Docutils 0.10 (2012-12-16)" and will soon be removed.  CC       bgpd/bgp_addpath.o
bgpd/bgp_clist.c: In function ecommunity_list_match_delete:
bgpd/bgp_clist.c:983:9: warning: missing braces around initializer [-Wmissing-braces]
bgpd/bgp_clist.c:983:9: warning: (near initialization for local_eval.val) [-Wmissing-braces]

Ubuntu 18.04 amd64 build: Failed (click for details)

Ubuntu 18.04 amd64 build: Unknown Log URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U1804AMD64/config.log/config.log.gz Ubuntu 18.04 amd64 build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U1804AMD64/config.status/config.status

Make failed for Ubuntu 18.04 amd64 build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U1804AMD64/ErrorLog/log_make.txt)

make  all-am
make[1]: Entering directory '/home/ci/cibuild.14398/frr-source'
Extension error:
when adding directive classes, no additional arguments may be given
Makefile:15307: recipe for target 'doc/user/_build/.doctrees/environment.pickle' failed
make[1]: *** [doc/user/_build/.doctrees/environment.pickle] Error 1
make[1]: Leaving directory '/home/ci/cibuild.14398/frr-source'
make[1]: Target 'all-am' not remade because of errors.
Makefile:5781: recipe for target 'all' failed

FreeBSD 12 amd64 build: Failed (click for details)

FreeBSD 12 amd64 build: Unknown Log URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/FBSD12AMD64/config.log/config.log.gz FreeBSD 12 amd64 build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/FBSD12AMD64/config.status/config.status

Make failed for FreeBSD 12 amd64 build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/FBSD12AMD64/ErrorLog/log_make.txt)

gmake  all-am
gmake[1]: Entering directory '/usr/home/ci/cibuild.14398/frr-source'
Extension error:
when adding directive classes, no additional arguments may be given
gmake[1]: *** [Makefile:17927: doc/user/_build/.doctrees/environment.pickle] Error 1
gmake[1]: Leaving directory '/usr/home/ci/cibuild.14398/frr-source'
gmake[1]: Target 'all-am' not remade because of errors.
gmake: *** [Makefile:6469: all] Error 2

Redhat 8 amd64 build: Failed (click for details)

Redhat 8 amd64 build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/REDHAT8/config.status/config.status

Make failed for Redhat 8 amd64 build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/REDHAT8/ErrorLog/log_make.txt)

make  all-am
make[1]: Entering directory '/home/ci/cibuild.14398/frr-source'
Extension error:
when adding directive classes, no additional arguments may be given
make[1]: *** [Makefile:17927: doc/user/_build/.doctrees/environment.pickle] Error 2
make[1]: Leaving directory '/home/ci/cibuild.14398/frr-source'
make[1]: Target 'all-am' not remade because of errors.
make: *** [Makefile:6469: all] Error 2

Redhat 8 amd64 build: Unknown Log <config.log.gz>
URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/REDHAT8/config.log/config.log.gz

Ubuntu 18.04 i386 build: Failed (click for details)

Make failed for Ubuntu 18.04 i386 build:
(see full Make log at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U18I386BUILD/ErrorLog/log_make.txt)

make  all-am
make[1]: Entering directory '/home/ci/cibuild.14398/frr-source'
Extension error:
when adding directive classes, no additional arguments may be given
Makefile:15307: recipe for target 'doc/user/_build/.doctrees/environment.pickle' failed
make[1]: *** [doc/user/_build/.doctrees/environment.pickle] Error 1
make[1]: Leaving directory '/home/ci/cibuild.14398/frr-source'
make[1]: Target 'all-am' not remade because of errors.
Makefile:5781: recipe for target 'all' failed

Ubuntu 18.04 i386 build: config.status output from configure script can be found at https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U18I386BUILD/config.status/config.status
Ubuntu 18.04 i386 build: Unknown Log <config.log.gz>
URL: https://ci1.netdef.org/browse/FRR-PULLREQ2-14398/artifact/U18I386BUILD/config.log/config.log.gz

Successful on other platforms/tests

Ubuntu 20.04 amd64 build
Ubuntu 22.04 amd64 build
Debian 10 amd64 build
FreeBSD 11 amd64 build
Redhat 9 amd64 build
Debian 11 amd64 build
OpenBSD 7 amd64 build

Jafaral · 2023-10-12T16:37:39Z

ci:rerun

qlyoung · 2023-10-12T17:43:57Z

Nah this is a legitimate failure, I just haven't had time to fix it

qlyoung · 2023-12-01T16:30:08Z

Reviewing the platforms the build failed on, my conclusion is the version of sphinx being used by the CI Ubuntu 18.04 VMs is too old. Other platforms have other issues.

I am not sure what we should do to rectify that. We could install a newer Sphinx package; this would require updating the build documentation for 18.04 as well. Alternatively, we could drop support for 18.04, which is no longer supported by Canonical. Another alternative is to add a condition in this code to handle multiple versions of Sphinx. I would prefer to avoid doing that.

qlyoung · 2024-04-03T02:44:16Z

ci:rerun

qlyoung · 2024-06-27T02:39:59Z

ci:rerun

github-actions · 2024-06-27T18:45:42Z

This pull request has conflicts, please resolve those before we can evaluate the pull request.

Multiple daemons have the same CLI commands defined, but the current directive used to document CLI commands only takes the command definition string. Since CLI command objects can be cross-referenced using the :clicmd: directive, and are placed in the index, each object needs to be unique. To accomplish this, add a custom directive. This directive extends the directive class used by sphinx's add_object_type to add a :daemon: option. By specifying this option where needed, the object name becomes "(<daemon>) <definition>", disambiguating it. Signed-off-by: Quentin Young <qlyoung@qlyoung.net>

Not supported. Signed-off-by: Quentin Young <qlyoung@qlyoung.net>

frrbot bot added the documentation label Sep 29, 2023

github-actions bot added master size/M labels Sep 29, 2023

qlyoung force-pushed the fix-clicmd-duplicates-issue branch from 3c70616 to ef7f302 Compare September 29, 2023 00:34

Jafaral self-requested a review October 3, 2023 15:48

qlyoung force-pushed the fix-clicmd-duplicates-issue branch from ef7f302 to 31a66e1 Compare June 26, 2024 19:27

github-actions bot added the conflicts label Jun 27, 2024

qlyoung force-pushed the fix-clicmd-duplicates-issue branch from 24edd63 to c7ebe10 Compare June 27, 2024 18:47

github-actions bot removed the conflicts label Jun 27, 2024

doc: do not use custom directive on old sphinx

ffbad58

Not supported. Signed-off-by: Quentin Young <qlyoung@qlyoung.net>

qlyoung force-pushed the fix-clicmd-duplicates-issue branch from c7ebe10 to ffbad58 Compare June 27, 2024 18:48

choppsv1 merged commit 2cc9348 into FRRouting:master Jun 28, 2024
11 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: add ability to disambiguate clicmds #14509

doc: add ability to disambiguate clicmds #14509

qlyoung commented Sep 29, 2023 •

edited

Loading

NetDEF-CI commented Sep 29, 2023 •

edited

Loading

Continuous Integration Result: FAILED

Get source / Pull Request: Successful

Building Stage: Incomplete

NetDEF-CI commented Sep 29, 2023 •

edited

Loading

Continuous Integration Result: FAILED

Get source / Pull Request: Successful

Building Stage: Incomplete

NetDEF-CI commented Oct 9, 2023

Jafaral commented Oct 12, 2023

qlyoung commented Oct 12, 2023

qlyoung commented Dec 1, 2023 •

edited

Loading

qlyoung commented Apr 3, 2024

qlyoung commented Jun 27, 2024

github-actions bot commented Jun 27, 2024

doc: add ability to disambiguate clicmds #14509

doc: add ability to disambiguate clicmds #14509

Conversation

qlyoung commented Sep 29, 2023 • edited Loading

NetDEF-CI commented Sep 29, 2023 • edited Loading

Continuous Integration Result: FAILED

Get source / Pull Request: Successful

Building Stage: Incomplete

NetDEF-CI commented Sep 29, 2023 • edited Loading

Continuous Integration Result: FAILED

Get source / Pull Request: Successful

Building Stage: Incomplete

NetDEF-CI commented Oct 9, 2023

Continuous Integration Result: FAILED

Get source / Pull Request: Successful

Building Stage: Failed

Jafaral commented Oct 12, 2023

qlyoung commented Oct 12, 2023

qlyoung commented Dec 1, 2023 • edited Loading

qlyoung commented Apr 3, 2024

qlyoung commented Jun 27, 2024

github-actions bot commented Jun 27, 2024

qlyoung commented Sep 29, 2023 •

edited

Loading

NetDEF-CI commented Sep 29, 2023 •

edited

Loading

NetDEF-CI commented Sep 29, 2023 •

edited

Loading

qlyoung commented Dec 1, 2023 •

edited

Loading