Skip to content

doc: do not rebuild riot.css#19665

Merged
bors[bot] merged 1 commit intoRIOT-OS:masterfrom
maribu:fix-issue-8122
May 25, 2023
Merged

doc: do not rebuild riot.css#19665
bors[bot] merged 1 commit intoRIOT-OS:masterfrom
maribu:fix-issue-8122

Conversation

@maribu
Copy link
Copy Markdown
Member

@maribu maribu commented May 24, 2023

Contribution description

  • simplify the makefile
    • changing behavior depending on lessc being installed is surprising and makes the Makefile less readable
    • failing with make: lessc: No such file or directory is helpful, but make: No rule to make target 'src/css/riot.css' is not clearly indicating that lessc was not found
  • don't rebuild riot.css when generating HTML output
    • anyone touching the less file will have to manually call make src/css/riot.css -C doc/doxygen
    • this happens so rarely that implementing a convenient mechanism is not worth the trouble

Testing procedure

make doc should no longer regenerate riot.css, regardless of whether lessc is available or not.

Issues/PRs references

Fixes #8122

- simplify the makefile
    - changing behavior depending on lessc being installed is
      surprising and makes the Makefile less readable
    - failing with `make: lessc: No such file or directory` is helpful,
      but `make: No rule to make target 'src/css/riot.css'` is not
      clearly indicating that `lessc` was not found
- don't rebuild `riot.css` when generating HTML output
    - anyone touching the less file will have to manually call
      `make src/css/riot.css -C doc/doxygen`
    - this happens so rarely that implementing a convenient mechanism
      is not worth the trouble

Fixes RIOT-OS#8122
@maribu maribu added Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors) Area: doc Area: Documentation Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs labels May 24, 2023
@maribu maribu requested review from aabadie and jia200x as code owners May 24, 2023 19:34
@riot-ci
Copy link
Copy Markdown

riot-ci commented May 24, 2023

Murdock results

✔️ PASSED

cfee27c doc: do not rebuild riot.css

Success Failures Total Runtime
1 0 1 51s

Artifacts

@maribu
Copy link
Copy Markdown
Member Author

maribu commented May 25, 2023

bors merge

@bors
Copy link
Copy Markdown
Contributor

bors bot commented May 25, 2023

Build succeeded!

The publicly hosted instance of bors-ng is deprecated and will go away soon.

If you want to self-host your own instance, instructions are here.
For more help, visit the forum.

If you want to switch to GitHub's built-in merge queue, visit their help page.

@bors bors bot merged commit 84a3078 into RIOT-OS:master May 25, 2023
@maribu maribu deleted the fix-issue-8122 branch May 25, 2023 17:55
@maribu
Copy link
Copy Markdown
Member Author

maribu commented May 25, 2023

Thx :)

@benpicco benpicco added this to the Release 2023.07 milestone Aug 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doxygen: riot.css modified by 'make doc'

3 participants