Fix build and usage instructions in README.md #271
Merged
Conversation
This file contains 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
mtrmac
force-pushed
the
fix-and-doc-build
branch
2 times, most recently
from
b178595
to
fe25008
Compare
mtrmac
force-pushed
the
fix-and-doc-build
branch
3 times, most recently
from
0170e1c
to
3185f97
Compare
mtrmac
force-pushed
the
fix-and-doc-build
branch
2 times, most recently
from
87e755a
to
66f8fa5
Compare
|
@runcom PTAL |
|
LGTM |
This is not really a new content, just emphasizing the existence of skopeo as a starting point—and highlights `copy.Image`. Signed-off-by: Miloslav Trmač <[email protected]>
Be a bit more explicit about the lack of “vendor” subdirectory. … and use a file name instead of “here” as a link title to make it easier to see what it points to. Signed-off-by: Miloslav Trmač <[email protected]>
…” section It is not something people just wanting to use the project care about, and we want to make the containers_image_openpgp tag clearly related. Signed-off-by: Miloslav Trmač <[email protected]>
Some people asking “how to build this” really shouldn't. Signed-off-by: Miloslav Trmač <[email protected]>
(go build ./...) is entirely useless when not developing this project: per (go help build): > When compiling multiple packages or a single non-main package, > build compiles the packages but discards the resulting object, > serving only as a check that the packages can be built. Instead, add a starting point for integrating the library into a user. Signed-off-by: Miloslav Trmač <[email protected]>
… instead of just documenting how to avoid it. And move the (make BUILDTAGS=…) variant into the “Contributing” subsection, it is not useful when integrating this into another project. Signed-off-by: Miloslav Trmač <[email protected]>
|
👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
See the individual commit messages for details.
This should help with #268, and fixes #270.
(Re: #270, this completely removes any mention of
go build ./...without replacement; as #268 shows,./...is undesirable because it includes all depdendencies, andgo build $(PACKAGES)inMakefileis unnecessary becausego test $(PACKAGES)builds all of the named subpackages, even those which don’t have any tests.)@hferentschik is this sufficient? (The containers/storage build failure will be fixed separately.)