Document how to extra a subset of an archive and moving it to a new root #8494
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
lacasseio
added
from:member
in:documentation-infrastructure
a:chore
This was referenced Feb 13, 2019
lacasseio
force-pushed
the
lacasseio/issue-5405
branch
from
dfcdf08
to
347a1c8
Compare
pledbrook
suggested changes
Feb 13, 2019
subprojects/docs/src/samples/userguide/files/archives/groovy/build.gradle
Outdated
Show resolved
Hide resolved
subprojects/docs/src/samples/userguide/files/archives/groovy/build.gradle
Outdated
Show resolved
Hide resolved
pledbrook
suggested changes
Feb 14, 2019
subprojects/docs/src/samples/userguide/files/archives/groovy/build.gradle
Outdated
Show resolved
Hide resolved
pledbrook
approved these changes
Feb 15, 2019
|
|
||
| .Unpacking a subset of a ZIP file | ||
| ==== | ||
| include::sample[dir="userguide/files/archives/groovy",files="build.gradle[tags=unpack-archive-subset-example]"] | ||
| include::sample[dir="userguide/files/archives/kotlin",files="build.gradle.kts[tags=unpack-archive-subset-example]"] | ||
| ==== | ||
| <1> Extracting only the files under `libs` directly into the destination directory | ||
| <2> Remap the extracting files to a different path into the destination directory by dropping the `libs` segment from the file path |
There was a problem hiding this comment.
Please rephrase the annotation text (or I can do it after a merge if you'd like). They should be worded based on asking yourself "what does this line do?" and then answering that question with "It ...". The " ..." is what goes into the annotation.
For example, what does line <1> do? It "extracts only the subset of files that reside in the libs directory.
As I said, I'm more than happy to modify these after you merge if you'd like.
There was a problem hiding this comment.
Sounds good. Let me try something and you can see if it's good.
pledbrook
reviewed
Feb 18, 2019
| <3> See Caution note below | ||
| <1> Extracts only the subset of files that reside in the `libs` directory | ||
| <2> Remaps the path of the extracting files into the destination directory by dropping the `libs` segment from the file path | ||
| <3> Ignores the empty directories resulting from the remapping, see Caution note below |
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.
Context
Fixes: #1108
Add documentation for a comment use case. A bug is still present preventing to properly handle empty directories. However, there is a workaround it. A cleaner solution for that specific case will be done as part of #2940
Gradle Core Team Checklist