Skip to content

Copy the generated man pages to the release archive#295

Merged
MartinNowak merged 1 commit intodlang:masterfrom
wilzbach:use_generated
Jan 25, 2018
Merged

Copy the generated man pages to the release archive#295
MartinNowak merged 1 commit intodlang:masterfrom
wilzbach:use_generated

Conversation

@wilzbach
Copy link
Contributor

See also: dlang/dmd#7669

@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.

- generated on linux when building docs
@MartinNowak
Copy link
Member

Still getting some nonsense output from dlang.org.

mkdir -p /home/vagrant/docs/docs/man/man1/
cp ../dmd/generated/docs/man/man1/dmd.1 /home/vagrant/docs/docs/man/man1/dmd.1
# CircleCi + nightlies.dlang.org might not have `man` installed
if command -v man > /dev/null ; then \
		make -s -C ../dmd/docs DMD=/home/vagrant/clones/dlang.org/.generated/stable_dmd-2.077.1/dmd2/linux/bin32/dmd DIFFABLE= preview > /home/vagrant/docs/docs/man/man1/dmd.txt; \
	fi
<standard input>:139: warning: numeric expression expected (got `s')

Why is the man page copied to the web folder, for diffing?
Dlang.org is also the only reason why the man page is build, seems a bit hacky.

Furthermore the dependency $(MAN_PAGE) on the preview target does not exist
https://github.com/dlang/dmd/blob/18ba25dcf81edfc437c54ee6b5445489d395500a/docs/Makefile#L25

and path and variable name are inconsistent between https://github.com/dlang/dlang.org/blob/4e07e9f5da92c45329bdcfb8d0195b4084ec1042/posix.mak#L349 (MAN_PAGE=docs/man/man1/dmd.1) and https://github.com/dlang/dmd/blob/18ba25dcf81edfc437c54ee6b5445489d395500a/docs/Makefile#L5 (DMD_MAN_PAGE=man/man1/dmd.1).

@MartinNowak
Copy link
Member

The man page is a little OS specific (-fPIC et.al.), but that should be fine for now.
Maybe make the generated man page generic for all OSes if you feel that's worth the effort.

@MartinNowak MartinNowak merged commit b18953a into dlang:master Jan 25, 2018
@wilzbach wilzbach deleted the use_generated branch January 25, 2018 16:16
@wilzbach
Copy link
Contributor Author

Thanks!

Still getting some nonsense output from dlang.org.

Interesting, but according to https://lists.gnu.org/archive/html/groff/2008-02/msg00071.html it's harmless :O

Why is the man page copied to the web folder, for diffing?

Yes, s.t. changes can be previewed easily.

Dlang.org is also the only reason why the man page is build, seems a bit hacky.

Oh that wasn't on purpose. It's built on the install target too - I thought that one is run here.
Should I add a separate man target to the posix.mak or should we call the makefile in docs directly?

Maybe make the generated man page generic for all OSes if you feel that's worth the effort.

I don't think that's worth it.

Furthermore the dependency $(MAN_PAGE) on the preview target does not exist

Oh sorry -> dlang/dmd#7776

and path and variable name are inconsistent between

Yeah that was a bit on purpose.
For dlang.org it was nice to do the following

$W/$(MAN_PAGE): $(DMD_DIR)/generated/$(MAN_PAGE)

Well, if my makefile unification, ever gets approved, I'm happy to incorporate the man page variable into it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants