Skip to content

Improve Makefiles for generating other documentation #954

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 24 commits into from
Feb 4, 2022
Merged

Improve Makefiles for generating other documentation #954

merged 24 commits into from
Feb 4, 2022

Conversation

Weltraumschaf
Copy link
Member

No description provided.

@Weltraumschaf
#754 Add missing SPDX header
168dae9 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
#754 Fix the PHONY make targets
5859fc0 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
#754 Add FIXME tags to spot the places
cdf1bf1 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
#754 Introduce Make vars for hooks
1ce34c3 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
#754 Break down long lines for readability
bb12eb7 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
#754 Use quotes to prevent word splitting
5bdeb6d 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
#754 Remove backtics in string because it will interpret string as co…
53faa1e 
…mmand

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
#754 Remove .ONESHELL form hook-docs target
1e052e7 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
#754 Use a more generic name for script
dc73ca5 
I plan to use it also to generate the other docs.

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
#754 Extend dco generator script to enable various doc types
8bb3a51 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
#754 Extract hook docs generation code into shel script
1aa5265 
Code duplication will be refactored in the next steps.

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
#754 Fix target name according to the general naming
184fcbe 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
#754 Introduce make vars for demo targets
c9af761 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
#754 Extract function to validate script args
97e5dbf 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
#754 Add empty stub function for generating demo target doc
0f50432 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
#754 Extract function to generate demo target docs
e0702aa 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
#754 Fix target name by only use one plural s
7d5457d 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf Weltraumschaf self-assigned this Feb 3, 2022
@Weltraumschaf Weltraumschaf added the bug Bugs label Feb 3, 2022
@Weltraumschaf Weltraumschaf linked an issue Feb 3, 2022 that may be closed by this pull request
make scanner-docs / hook-docs fails on macOS #754
Closed
@Weltraumschaf
#754 Fix workflow scripts after target renaming
2026217 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
#754 Use same naming schema for generator functions
39b05e6 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
#754 Add function stubs for operator and auto discovery docs
7b938d0 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
#754 Extract operator doc generation as function
afb1faa 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
#754 Extract auto discovery doc generation as function
d1cbcc1 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
#754 Break down lines for readability
06e0725 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
#754 Use vars and quotes
ad04a86 
Makes target more reliable:

- quotes prevent word splitting ofpaths
- variables helps for further refactoring

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
Copy link
Member Author

All targets are fixed and work on macOS.

malexmave
malexmave approved these changes Feb 4, 2022
View reviewed changes
Copy link
Member

@malexmave malexmave left a comment

Choose a reason for hiding this comment

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

Works great, tested it for scanners, hooks, demo-targets, operator and auto-discovery.

@malexmave malexmave changed the title Next bunch of ONESHELL fixes Improve Makefiles for generating other documentation Feb 4, 2022
@malexmave malexmave merged commit 1c3af11 into main Feb 4, 2022
@malexmave malexmave deleted the bugfix/issue_754 branch February 4, 2022 09:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@malexmave malexmave malexmave approved these changes

Assignees

@Weltraumschaf Weltraumschaf

Labels
bug Bugs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

make scanner-docs / hook-docs fails on macOS
2 participants
@Weltraumschaf @malexmave