Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

0.18.3: documentation build warnings #126

Open
kloczek opened this issue Dec 30, 2023 · 0 comments
Open

0.18.3: documentation build warnings #126

kloczek opened this issue Dec 30, 2023 · 0 comments

Comments

@kloczek
Copy link

kloczek commented Dec 30, 2023

Sphinx warnings `reference target not found"
+ /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man
Running Sphinx v7.1.2
making output directory... done
building [mo]: targets for 0 po files that are out of date
writing output...
building [man]: all manpages
updating environment: [new config] 7 added, 0 changed, 0 removed
reading sources... [100%] server
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/fsm.rst:12: WARNING: Type must be either just a name or a typedef-like declaration.
If just a name:
  Error in declarator or parameters
  Invalid C declaration: Expected identifier in nested name, got keyword: struct [error at 6]
    struct raft_fsm
    ------^
If typedef-like declaration:
  Error in declarator or parameters
  Invalid C declaration: Expected identifier in nested name. [error at 15]
    struct raft_fsm
    ---------------^

/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:12: WARNING: Type must be either just a name or a typedef-like declaration.
If just a name:
  Error in declarator or parameters
  Invalid C declaration: Expected identifier in nested name, got keyword: struct [error at 6]
    struct raft_io
    ------^
If typedef-like declaration:
  Error in declarator or parameters
  Invalid C declaration: Expected identifier in nested name. [error at 14]
    struct raft_io
    --------------^

/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:32: WARNING: Duplicate C declaration, also defined at fsm:19.
Declaration is '.. c:member:: void* data'.
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:37: WARNING: Duplicate C declaration, also defined at fsm:24.
Declaration is '.. c:member:: int version'.
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/server.rst:12: WARNING: Type must be either just a name or a typedef-like declaration.
If just a name:
  Error in declarator or parameters
  Invalid C declaration: Expected identifier in nested name, got keyword: struct [error at 6]
    struct raft
    ------^
If typedef-like declaration:
  Error in declarator or parameters
  Invalid C declaration: Expected identifier in nested name. [error at 11]
    struct raft
    -----------^

/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/server.rst:28: WARNING: Duplicate C declaration, also defined at fsm:19.
Declaration is '.. c:member:: void* data'.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... c-raftdocumentation.1 { getting-started api server fsm io disk-format } /home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/server.rst:3: WARNING: Unparseable C cross-reference: 'struct raft'
Invalid C declaration: Expected identifier in nested name, got keyword: struct [error at 6]
  struct raft
  ------^
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/server.rst:3: WARNING: c:type reference target not found: struct raft
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/server.rst:20: WARNING: c:identifier reference target not found: raft
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/server.rst:40: WARNING: c:identifier reference target not found: raft
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/server.rst:40: WARNING: c:identifier reference target not found: raft_io
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/server.rst:40: WARNING: c:identifier reference target not found: raft_fsm
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/server.rst:44: WARNING: c:identifier reference target not found: raft
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/server.rst:51: WARNING: c:identifier reference target not found: raft
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/server.rst:55: WARNING: Unparseable C cross-reference: 'raft_io->load'
Invalid C declaration: Expected end of definition. [error at 7]
  raft_io->load
  -------^
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/server.rst:55: WARNING: c:func reference target not found: raft_io->load
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/fsm.rst:3: WARNING: Unparseable C cross-reference: 'struct raft_fsm'
Invalid C declaration: Expected identifier in nested name, got keyword: struct [error at 6]
  struct raft_fsm
  ------^
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/fsm.rst:3: WARNING: c:type reference target not found: struct raft_fsm
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/fsm.rst:28: WARNING: c:identifier reference target not found: raft_fsm
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/fsm.rst:28: WARNING: c:identifier reference target not found: raft_buffer
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/fsm.rst:32: WARNING: c:identifier reference target not found: raft_fsm
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/fsm.rst:32: WARNING: c:identifier reference target not found: raft_buffer
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/fsm.rst:36: WARNING: c:identifier reference target not found: raft_fsm
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/fsm.rst:36: WARNING: c:identifier reference target not found: raft_buffer
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:3: WARNING: Unparseable C cross-reference: 'struct raft_io'
Invalid C declaration: Expected identifier in nested name, got keyword: struct [error at 6]
  struct raft_io
  ------^
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:3: WARNING: c:type reference target not found: struct raft_io
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:16: WARNING: c:identifier reference target not found: raft_io
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:18: WARNING: c:func reference target not found: raft_io.close
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:20: WARNING: c:identifier reference target not found: raft_io
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:24: WARNING: c:identifier reference target not found: raft_io
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:24: WARNING: c:identifier reference target not found: raft_message
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:45: WARNING: c:identifier reference target not found: RAFT_ERRMSG_BUF_SIZE
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:50: WARNING: c:identifier reference target not found: raft_io
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:55: WARNING: c:identifier reference target not found: raft_io
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:59: WARNING: c:type reference target not found: raft_io
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:64: WARNING: c:identifier reference target not found: raft_io
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:64: WARNING: c:identifier reference target not found: raft_term
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:64: WARNING: c:identifier reference target not found: raft_snapshot
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:64: WARNING: c:identifier reference target not found: raft_index
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:64: WARNING: c:identifier reference target not found: raft_entry
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:64: WARNING: c:identifier reference target not found: size_t
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:72: WARNING: c:func reference target not found: raft_io.append
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:76: WARNING: c:func reference target not found: raft_malloc
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:80: WARNING: c:identifier reference target not found: raft_io
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:88: WARNING: c:identifier reference target not found: raft_io
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:88: WARNING: c:identifier reference target not found: raft_configuration
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:99: WARNING: c:identifier reference target not found: raft_io
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:99: WARNING: c:identifier reference target not found: raft_configuration
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:103: WARNING: c:identifier reference target not found: raft_io
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:103: WARNING: c:identifier reference target not found: raft_term
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:110: WARNING: c:identifier reference target not found: raft_io
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:117: WARNING: c:identifier reference target not found: raft_io
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:117: WARNING: c:identifier reference target not found: raft_io_send
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:117: WARNING: c:identifier reference target not found: raft_message
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:117: WARNING: c:identifier reference target not found: raft_io_send_cb
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:124: WARNING: c:identifier reference target not found: raft_io
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:124: WARNING: c:identifier reference target not found: raft_io_append
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:124: WARNING: c:identifier reference target not found: raft_entry
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:124: WARNING: c:identifier reference target not found: raft_io_append_cb
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:131: WARNING: c:identifier reference target not found: raft_io
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:131: WARNING: c:identifier reference target not found: raft_index
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:135: WARNING: c:identifier reference target not found: raft_io
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:135: WARNING: c:identifier reference target not found: raft_io_snapshot_put
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:135: WARNING: c:identifier reference target not found: raft_snapshot
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:135: WARNING: c:identifier reference target not found: raft_io_snapshot_put_cb
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:147: WARNING: c:identifier reference target not found: raft_io
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:147: WARNING: c:identifier reference target not found: raft_io_snapshot_get
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:147: WARNING: c:identifier reference target not found: raft_io_snapshot_get_cb
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:151: WARNING: c:identifier reference target not found: raft_time
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:151: WARNING: c:identifier reference target not found: raft_io
/home/tkloczko/rpmbuild/BUILD/raft-0.18.3/docs/io.rst:155: WARNING: c:identifier reference target not found: raft_io
done
build succeeded, 71 warnings.

You can peak on fixes that kind of issues in other projects
RDFLib/rdflib-sqlalchemy#95
RDFLib/rdflib#2036
click-contrib/sphinx-click@abc31069
frostming/unearth#14
jaraco/cssutils#21
latchset/jwcrypto#289
latchset/jwcrypto#289
pypa/distlib@98b9b89f
pywbem/pywbem#2895
sissaschool/elementpath@bf869d9e
sissaschool/xmlschema@42ea98f2
sqlalchemy/sqlalchemy@5e88e6e8

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant