Skip to content
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.

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

Polish docs Makefile #3045

Merged
merged 1 commit into from
Jul 19, 2024
Merged

Polish docs Makefile #3045

merged 1 commit into from
Jul 19, 2024

Conversation

happz
Copy link
Collaborator

@happz happz commented Jun 25, 2024

  • add comments to variables, targets and their groups,
  • reduce duplication with custom functions (mostly around plugin docs),
  • slightly increased padding for target name when rendering help, to keep things aligned even for the longest target.

Pull Request Checklist

  • implement the feature

@happz happz added documentation Improvements or additions to documentation code | no functional change "No Functional Change" intended. Patch should not change tmt's behavior in any way. labels Jun 25, 2024
@happz happz added this to the 1.35 milestone Jun 25, 2024
@happz happz force-pushed the docs-more-dry-in-makefile branch from ed070cd to b652e86 Compare June 25, 2024 21:25
@LecrisUT
Copy link
Contributor

Btw, doesn't the makefile not account for the fmf file dependencies right now? There are even more subtle dependencies on git branch and such when we were looking at linkcheck (is there really no sphinx role or such to point to git repo files?).

@happz
Copy link
Collaborator Author

happz commented Jun 26, 2024

Btw, doesn't the makefile not account for the fmf file dependencies right now?

Nope, not yet, although I could add collection of spec/story fmf files & add them as dependencies. That shouldn't be hard, and it's quite a visible dependency.

There are even more subtle dependencies on git branch and such when we were looking at linkcheck (is there really no sphinx role or such to point to git repo files?).

True, but I chose to ignore those :) If we start adding these, we should probably fix also the top-level Makefile as it builds bits from the sources, a branch change would affect the outcome for sure.

Copy link
Collaborator

@thrix thrix left a comment

Choose a reason for hiding this comment

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

LGTM

@psss
Copy link
Collaborator

psss commented Jul 18, 2024

@happz, could you please rebase on the latest main?

@happz happz force-pushed the docs-more-dry-in-makefile branch from b652e86 to 05394ea Compare July 18, 2024 14:24
@happz happz added the status | ready for merge The only missing piece is to do the rebase the current 'main' and let the CI finish. label Jul 18, 2024
* add comments to variables, targets and their groups,
* reduce duplication with custom functions (mostly around plugin docs),
* slightly increased padding for target name when rendering help, to
  keep things aligned even for the longest target.
@psss psss force-pushed the docs-more-dry-in-makefile branch from 05394ea to a08a4be Compare July 18, 2024 21:27
@psss psss self-assigned this Jul 19, 2024
@psss psss merged commit a08a4be into main Jul 19, 2024
11 of 19 checks passed
@psss psss deleted the docs-more-dry-in-makefile branch July 19, 2024 06:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code | no functional change "No Functional Change" intended. Patch should not change tmt's behavior in any way. documentation Improvements or additions to documentation status | ready for merge The only missing piece is to do the rebase the current 'main' and let the CI finish.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants