Infrastructure for templated doc in POD files#10159
Infrastructure for templated doc in POD files#10159richsalz wants to merge 2 commits intoopenssl:masterfrom richsalz:doc-template
Conversation
|
I added more error-checking to the dofile script; I wasted time because there were no errors output. I think dofile should have another flag that means "for input file foo.in write to foo" That would make the makefiles simpler and, given the error-checking addition, more correct now. |
|
You haven't elaborated how this would be integrated in the build system. Remember, the first token in a GENERATE value is the generator, and that's the Something I don't understand, though, is how the introduction of for this (which isn't what I would call intuitive): Right? A totally different thing, though, is the error handling. That is nicely fixed, and quite frankly, if there was a PR with only that fix, I would approve it on the spot. Sometimes, dividing things onto one-theme PRs is a good thing, ya know 😉 |
|
|
That doesn't help parallell jobs much. Also, |
|
Fixup commit pushed. I don't think you'll like the way I did the Unix makefile, but I couldn't make my way through the depth of the templates. And anyway we still need to resolve the other system.s |
|
Regarding your Makefile template hack, you're right that I strongly dislike it. That's one more hack that we must remember to duplicate across all build file templates, so that's the wrong direction to follow. Specifying the file generation via GENERATE lines in As it is right now, the GENERATE line just takes the value and uses that as arguments with no regard for anything, so for example, this line: Translates to (on my setup): However, what we could do to support your kind of construct is to translate something like this: to: |
|
(as a matter of fact, that |
|
#10162 allows the following construct: Add that to the top |
|
I will rebase and use the your technique once #10162 is merged. |
|
So additional commit pushed. Now I just need to know which build.info file ? Should I add a new one in doc? If so, how do I do that. |
|
So far, I've touch the top one. However, if you prefer to add one in |
|
And add a target/dependency to build_generated? |
|
(Adding that dependency means modifying the three makefile templates, right?) |
|
Nope, that's done "magically" with this dependency: (the empty brackets are significant for this) |
|
I don't think my question was clear: how do I make sure that the templated-docs are built at the same time all other generated files are built? Are you saying, if I just put then it will work? |
|
Yes, that's right. Now, for your stuff specifically, since you depend on doc/perlvars.pm, you will also need this: |
|
this works, except |
|
Catch 22. perlvars.pm is loaded before dofile.pl starts and thereby before It's not quite as "magic" |
|
putting the text explicitly seems the simplest thing to do (for now :). |
|
also set, ready for review. thanks. |
|
It would be great if this could get reviewed and merged next. I will then rebase all the other doc refactoring PR's to use this. It will make reviewing those other half-dozen PR's much simpler, as it replaces whole clumps of line with a perl variable reference. Okay, I exaggerate. It's only five other PR's. But still... |
|
One, two, three, gazillion 😉 |
|
I am starting to backport #10118 (as a new PR) to use this. So yeah, a pico-gazillion at least. |
|
You do know, right, that you don't have to rebase all the time? It's only necessary when github shows you there's a merge conflict |
|
Everyone should have a hobby :) |
|
Yeah, so reviewers get to wonder if there's anything new to review, might realise that there isn't, possibly after looking at the latest force-pushed link... either way, that takes extra time, which may slow down approval. So for a hobby, it's not a smart one... |
|
I'll try to refrain. |
Use new doc-build capabilities Add -i flag to dofile. Add doc/man1 to SUBDIRS for the new templated doc files Rewrite commit a397aca (merged from PR 10118) to use the doc-template stuff. Put template references in common place Template options and text come at the end of command-specific options: opt_x, opt_trust, opt_r (in that order). Refactor xchain options. Do doc-nits after building generated sources.
t8m
left a comment
There was a problem hiding this comment.
Apart from the typo and nit looks ok.
Use new doc-build capabilities Add -i flag to dofile. Add doc/man1 to SUBDIRS for the new templated doc files Rewrite commit a397aca (merged from PR 10118) to use the doc-template stuff. Put template references in common place Template options and text come at the end of command-specific options: opt_x, opt_trust, opt_r (in that order). Refactor xchain options. Do doc-nits after building generated sources. Reviewed-by: Tomas Mraz <[email protected]> Reviewed-by: Richard Levitte <[email protected]> (Merged from #10159)
|
Merged to master as 9fcb970 |
|
Thanks for your feedback (and perl assistance) in getting this done! |
This adds infrastructure so that we can use Perl variables for common flags.
The build system, and manpages, aren't wired up to it yet.
This replaces #10156 which I am about to close.
This is ready for review.