Toolverse
All skills

rsyslog-doc-dist

by rsyslog

Ensures doc/Makefile.am stays in sync with changes to documentation files.

Installation

Pick a client and clone the repository into its skills directory.

Installation

Quick info

Author
rsyslog
Category
DevOps
Views
2

About this skill

Ensures doc/Makefile.am stays in sync with changes to documentation files.

How to use

  1. Kiedy dodajesz nowy plik RST w katalogu doc/source/, otwórz plik doc/Makefile.am i dodaj ścieżkę do zmiennej EXTRA_DIST, zachowując istniejące logiczne grupowanie (np. source/configuration/modules/).

  2. Jeśli przeniesiesz lub zmienisz nazwę pliku dokumentacji, zlokalizuj starą ścieżkę w doc/Makefile.am i zastąp ją nową lokalizacją.

  3. Gdy usuwasz plik dokumentacji, znajdź jego wpis w doc/Makefile.am i usuń go całkowicie, aby uniknąć błędów podczas make dist.

  4. Po każdej zmianie (dodanie, przeniesienie lub usunięcie) uruchom skrypt weryfikacyjny: bash .agent/skills/rsyslog_doc_dist/scripts/check-doc-dist.sh

  5. Skrypt automatycznie sprawdzi wersję projektu, uruchomi make dist, rozpakuje dystrybucję w katalogu tymczasowym, uruchomi configure oraz make html, a następnie wyczyści pliki tymczasowe.

  6. Jeśli skrypt zakończy się bez błędów, Twoja dokumentacja jest poprawnie zsynchronizowana i będzie dostępna w dystrybucji źródłowej.

Related skills