Skip to content

Add 'man' target to build the MAN pages#7637

Merged
wilzbach merged 4 commits intodlang:masterfrom
wilzbach:man-makefile
Jan 10, 2018
Merged

Add 'man' target to build the MAN pages#7637
wilzbach merged 4 commits intodlang:masterfrom
wilzbach:man-makefile

Conversation

@wilzbach
Copy link
Contributor

@wilzbach wilzbach commented Jan 8, 2018

We should be a bit careful here to avoid breaking the nightly builds.

  • Remove static dmd.1 in favor of the auto-generated one
  • Add 'man' target (builds the MAN pages)
  • Build MAN pages to generated
  • Document Makefile targets

CC other package maintainers: @Vild @jordisayol @WebDrake (who knows more?)

See also: #7507

@dlang-bot
Copy link
Contributor

Thanks for your pull request, @wilzbach!

Bugzilla references

Your PR doesn't reference any Bugzilla issue.

If your PR contains non-trivial changes, please reference a Bugzilla issue or create a manual changelog.

@wilzbach wilzbach requested a review from MartinNowak as a code owner January 8, 2018 12:23
src/posix.mak Outdated
# cxx-unittest Check conformance of the C++ headers
# build-examples Build DMD as library examples
# clean Remove all generated files
# man Build the MAN pages
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: "Generate the man pages" as that is the text used in the comment below.

@wilzbach wilzbach force-pushed the man-makefile branch 2 times, most recently from 3af734c to 6c5d542 Compare January 8, 2018 13:04
@wilzbach wilzbach added the Review:WIP Work In Progress - not ready for review or pulling label Jan 8, 2018
@wilzbach wilzbach removed the Review:WIP Work In Progress - not ready for review or pulling label Jan 8, 2018
@JinShil
Copy link
Contributor

JinShil commented Jan 9, 2018

Is it possible to add a test for this to our CIs? I'm thinking something simple that generates the man page and then verifies that the file actually contains something sane. I'm also worried that this can get broken somehow, and we'd only know about it after the release when one of our maintainers tries to create their package, or worse one of the users opens a man page with nothing or nonsense in it.

UPDATE: Or perhaps add the output to CyberShadow/DAutoTest

@wilzbach
Copy link
Contributor Author

wilzbach commented Jan 9, 2018

Is it possible to add a test for this to our CIs?

FYI: by adding it to the install target, which is run on e.g. auto-tester, we at least check that script doesn't error.

UPDATE: Or perhaps add the output to CyberShadow/DAutoTest

Yep, excellent idea: dlang/dlang.org#2067

@wilzbach
Copy link
Contributor Author

wilzbach commented Jan 9, 2018

As dlang/dlang.org#2067 is in, I rebased this PR and now we should see the changes on DAutoTest.

@wilzbach
Copy link
Contributor Author

So it turns out that dlang/dlang.org#2067 broke DAutoTest (sorry @CyberShadow) because we modify versioned files.
As this PR fixes this and was intended to be merged directly after dlang/dlang.org#2067, I suggest we give this a higher priority. Hence, I dropped the only potentially controversial commit - the removal of the static man page file (I will do that in a separate file).
@JinShil - you still have "requested changes" here. Are you okay with merging this? Before I rebased DAutoTest showed two lines changed - the year changes (DIFFABLE will only take effect with this PR).

@wilzbach wilzbach added the Review:Blocking Other Work review and pulling should be a priority label Jan 10, 2018
@wilzbach
Copy link
Contributor Author

Great it seems like the vibe.d and dub testsuite depend on code.dlang.org being online. I wonder dub doesn't fallback to use its mirrors there. Anyhow this change doesn't even touch the compiler source code. and unbreaks DAutoTest

@wilzbach wilzbach merged commit 4d827c1 into dlang:master Jan 10, 2018
@wilzbach wilzbach deleted the man-makefile branch January 10, 2018 11:38
wilzbach added a commit to wilzbach/dmd that referenced this pull request Jan 10, 2018
Follow-up to dlang#7637
Not sure whether the nightlies depend on the exact path.

CC @MartinNowak
wilzbach added a commit to wilzbach/dlang.org that referenced this pull request Jan 10, 2018
@wilzbach wilzbach changed the title Add 'man' target to build the MAN pages and remove static dmd.1 Add 'man' target to build the MAN pages Jan 15, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Merge:auto-merge Review:Blocking Other Work review and pulling should be a priority

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants