Restructure documentation dir#4354
Merged
openshift-merge-robot merged 2 commits intocontainers:masterfrom Oct 31, 2019
Merged
Conversation
Collaborator
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: baude The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Member
|
Changes LGTM, but gating is biting you. |
Member
|
LGTM |
2b4c255 to
17efbb3
Compare
Collaborator
|
☔ The latest upstream changes (presumably #4187) made this pull request unmergeable. Please resolve the merge conflicts. |
Member
TomSweeneyRedHat
left a comment
There was a problem hiding this comment.
LGTM assuming happy tests
9ee6078 to
64ea009
Compare
Member
Author
|
/test images |
Member
diff --git a/Makefile b/Makefile
index d04b5980f..73442eb7c 100644
--- a/Makefile
+++ b/Makefile
@@ -167,7 +167,7 @@ podman-remote: .gopathok $(PODMAN_VARLINK_DEPENDENCIES) ## Build with podman on
$(GO_BUILD) $(BUILDFLAGS) -gcflags '$(GCFLAGS)' -asmflags '$(ASMFLAGS)' -ldflags '$(LDFLAGS_PODMAN)' -tags "$(BUILDTAGS) remoteclient" -o bin/$@ $(PROJECT)/cmd/podman
.PHONY: podman.msi
-podman.msi: podman-remote podman-remote-windows install-podman-remote-docs ## Will always rebuild exe as there is no podman-remote-windows.exe target to verify timestamp
+podman.msi: podman-remote podman-remote-windows install-podman-remote-windows-docs ## Will always rebuild exe as there is no podman-remote-windows.exe target to verify timestamp
$(eval DOCFILE := docs/build/remote/windows)
find $(DOCFILE) -print \
|wixl-heat --var var.ManSourceDir --component-group ManFiles --directory-ref INSTALLDIR --prefix $(DOCFILE)/ >$(DOCFILE)/pages.wsx
@@ -319,13 +319,11 @@ docdir:
docs: docdir $(MANPAGES) ## Generate documentation
-install-podman-remote-docs: podman-remote docs $(MANPAGES)
+install-podman-remote-%-docs: podman-remote docs $(MANPAGES)
rm -rf docs/build/remote
mkdir -p docs/build/remote
ln -sf $(shell pwd)/docs/source/markdown/links docs/build/man/
- docs/remote-docs.sh darwin docs/build/remote/darwin docs/build/man
- docs/remote-docs.sh linux docs/build/remote/linux docs/build/man
- docs/remote-docs.sh windows docs/build/remote/windows docs/source/markdown
+ docs/remote-docs.sh $* docs/build/remote/$* $(if $(findstring windows,$*),docs/source/markdown,docs/build/man)
man-page-check:
hack/man-page-checker
@@ -352,7 +350,7 @@ podman-v$(RELEASE_NUMBER).tar.gz: binaries docs release.txt
# Must call make in-line: Dependency-spec. w/ wild-card also consumes variable value.
podman-remote-v$(RELEASE_NUMBER)-%.zip:
- $(MAKE) podman-remote-$* install-podman-remote-docs release.txt \
+ $(MAKE) podman-remote-$* install-podman-remote-$*-docs release.txt \
RELEASE_BASENAME=$(shell hack/get_release_info.sh REMOTENAME) \
RELEASE_DIST=$* RELEASE_DIST_VER="-"
$(eval TMPDIR := $(shell mktemp -d -p '' $podman_remote_XXXX))This avoids needing to have pandoc and wixl present on all platforms in order to build the remote client. |
Member
|
That's untested by the way. |
Restructuring the docs dir to make integration with sphinx easier. man pages now exist in docs/source/man and the sphinx make files exists in docs. Signed-off-by: baude <bbaude@redhat.com>
* Refactored code and Makefile to support new docs layout * Removed some old code packaging code * Add Readme.md to document what we're doing Signed-off-by: Jhon Honce <jhonce@redhat.com> Signed-off-by: baude <bbaude@redhat.com>
Member
|
/lgtm |
This was referenced Oct 31, 2019
Merged
Foxboron
added a commit
to Foxboron/libpod
that referenced
this pull request
Nov 2, 2019
The final versions of the documentation has been shifted from `docs/` to `docs/build/man`. Most of the Makefile has been changed accordingly, but the docker documentation generation was not. Introduced by containers#4354 Signed-off-by: Morten Linderud <morten@linderud.pw>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
9 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Restructuring the docs dir to make integration with sphinx easier. man
pages now exist in docs/source/man and the sphinx make files exists in
docs.
Signed-off-by: baude bbaude@redhat.com