Skip to content

conf.py: cpp_id_attributes = ["__sparse_cache"] - #414

Merged
marc-hb merged 3 commits into
thesofproject:masterfrom
marc-hb:sparse-cache
Jun 9, 2022
Merged

marc-hb merged 3 commits into
thesofproject:masterfrom
marc-hb:sparse-cache

Conversation

@marc-hb

@marc-hb marc-hb commented Jun 9, 2022

Copy link
Copy Markdown
Collaborator

With a recent enough sphinx-build --version, this fixes the gazillion of
warnings recently added:

/home/runner/work/sof-docs/sof-docs/api/component-api.rst:21: WARNING: Error when parsing function declaration.
If the function has no return type:
  Error in declarator or parameters-and-qualifiers
  Invalid C++ declaration: Expected identifier in nested name, got keyword: void [error at 18]
    static inline void comp_underrun (struct comp_dev *dev, struct comp_buffer __sparse_cache *source, uint32_t copy_bytes)
    ------------------^
If the function has a return type:
  Error in declarator or parameters-and-qualifiers
  If pointer to member declarator:
    Invalid C++ declaration: Expected '::' in pointer to member (function). [error at 33]
      static inline void comp_underrun (struct comp_dev *dev, struct comp_buffer __sparse_cache *source, uint32_t copy_bytes)
      ---------------------------------^
  If declarator-id:
    Invalid C++ declaration: Expecting "," or ")" in parameters-and-qualifiers, got "*". [error at 90]
      static inline void comp_underrun (struct comp_dev *dev, struct comp_buffer __sparse_cache *source, uint32_t copy_bytes)
      ------------------------------------------------------------------------------------------^

marc-hb added 3 commits June 8, 2022 18:04
With a recent enough sphinx-build --version, this fixes the gazillion of
warnings recently added:

```
/home/runner/work/sof-docs/sof-docs/api/component-api.rst:21: WARNING: Error when parsing function declaration.
If the function has no return type:
  Error in declarator or parameters-and-qualifiers
  Invalid C++ declaration: Expected identifier in nested name, got keyword: void [error at 18]
    static inline void comp_underrun (struct comp_dev *dev, struct comp_buffer __sparse_cache *source, uint32_t copy_bytes)
    ------------------^
If the function has a return type:
  Error in declarator or parameters-and-qualifiers
  If pointer to member declarator:
    Invalid C++ declaration: Expected '::' in pointer to member (function). [error at 33]
      static inline void comp_underrun (struct comp_dev *dev, struct comp_buffer __sparse_cache *source, uint32_t copy_bytes)
      ---------------------------------^
  If declarator-id:
    Invalid C++ declaration: Expecting "," or ")" in parameters-and-qualifiers, got "*". [error at 90]
      static inline void comp_underrun (struct comp_dev *dev, struct comp_buffer __sparse_cache *source, uint32_t copy_bytes)
      ------------------------------------------------------------------------------------------^
```

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
Fixes Sphinx 5 warning:

  Running Sphinx v5.0.1
  WARNING: Invalid configuration value found: 'language = None'. Update
  your configuration to a valid langauge code. Falling back to
  'en' (English).

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
Fixes Sphinx 5 warning:

WARNING: extlinks: Sphinx-6.0 will require a caption string to contain
exactly one '%s' and all other '%' need to be escaped as '%%'.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
@marc-hb
marc-hb marked this pull request as ready for review June 9, 2022 01:19
@marc-hb

marc-hb commented Jun 9, 2022

Copy link
Copy Markdown
Collaborator Author

Small, easy to revert and fixing a gazillion of warnings: abusing my super power and merging this.

@marc-hb
marc-hb merged commit d334f72 into thesofproject:master Jun 9, 2022
@marc-hb
marc-hb deleted the sparse-cache branch June 9, 2022 01:21

@greg-intel greg-intel left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

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

Successfully merging this pull request may close these issues.

2 participants