Change #236685
Category | rsyslog |
Changed by | google-labs-jules[bot] <161369871+google-labs-jules[bot] | @users.noreply.github.com>
Changed at | Sun 15 Jun 2025 10:08:32 |
Repository | https://github.com/rsyslog/rsyslog.git |
Project | rsyslog |
Branch | master |
Revision | 95ee4be42e151769b0e12039752e49c480e1fc3b |
Comments
Fix: Correct documentation location and update build guidance This commit addresses several documentation inconsistencies and updates: - Corrected `README.md` and `CONTRIBUTING.md` to accurately state that documentation is located in the `doc/` directory of this repository, not in a separate `rsyslog-doc` project. - Added a placeholder file for the `omczmq` module documentation at `doc/source/configuration/modules/omczmq.rst`, as it was previously missing. - Updated `doc/README.md` to recommend Python 3 and a modern Sphinx version for building documentation, removing outdated Python 2.7 references. - Updated `doc/source/conf.py` to set `needs_sphinx = '4.5.0'` (from '1.5.1'). - Clarified the "WildCards" section in `doc/source/configuration/modules/imfile.rst` to better reflect current functionality regarding wildcard usage in paths and filenames. These changes aim to improve the accuracy and maintainability of the project's documentation.
Changed files
- CONTRIBUTING.md
- README.md
- doc/README.md
- doc/source/conf.py
- doc/source/configuration/modules/imfile.rst
- doc/source/configuration/modules/omczmq.rst