Update docs to reflect default prune settings #1650

andrewjstone · 2018-02-07T22:55:49Z

What does this do / why do we need it?

The default prune settings have changed, but the docs have not been updated.

What should your reviewer look out for in this PR?

N/A

Do you need help or clarification on anything?

No

Which issue(s) does this PR fix?

This PR updates the docs for the following PR: #1460

googlebot · 2018-02-07T22:55:52Z

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed, please reply here (e.g. I signed it!) and we'll verify. Thanks.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.
If your company signed a CLA, they designated a Point of Contact who decides which employees are authorized to participate. You may need to contact the Point of Contact for your company and ask to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the project maintainer to go/cla#troubleshoot. The email used to register you as an authorized contributor must be the email used for the Git commit.
In order to pass this check, please resolve this problem and have the pull request author add another comment and the bot will run again. If the bot doesn't comment, it means it doesn't think anything has changed.

jmank88 · 2018-02-08T13:51:37Z

docs/Gopkg.toml.md

@@ -192,7 +192,8 @@ The following are the current available options:

 Out of an abundance of caution, dep non-optionally preserves files that may have legal significance.

-Pruning is disabled by default. It can be enabled by setting them to `true` at the root level.
+Pruning is enabled by default for `go-tests` and `unused-packages`. It can disabled by removing those fields from the `[prune]` table at the root level. Pruning can be enabled for `non-go` by setting it to true at the root level.
+


Though the default behavior generating a Gopkg.toml during init is to add go-tests and unused-packages, I think the language here is referring to the default behavior during processing of a Gopkg.toml when no explicit true/false value is provided. That being said, the original text could still use some clarification.

I agree with @jmank88 . How about:

Pruning options are disabled by default. Generating a Gopkg.toml generate through dep init will enable go-tests and unused-packages prune options by default.

Ah, ok. That makes sense. I will change the wording.

ibrasho · 2018-02-08T16:17:42Z

docs/Gopkg.toml.md

@@ -192,7 +192,8 @@ The following are the current available options:

 Out of an abundance of caution, dep non-optionally preserves files that may have legal significance.

-Pruning is disabled by default. It can be enabled by setting them to `true` at the root level.
+Pruning is enabled by default for `go-tests` and `unused-packages`. It can disabled by removing those fields from the `[prune]` table at the root level. Pruning can be enabled for `non-go` by setting it to true at the root level.
+
 ```toml
 [prune]
  non-go = true


I'd recommend replacing this line with:

go-tests = true unused-packages = true

ibrasho · 2018-02-08T16:17:44Z

docs/Gopkg.toml.md

@@ -192,7 +192,8 @@ The following are the current available options:

 Out of an abundance of caution, dep non-optionally preserves files that may have legal significance.

-Pruning is disabled by default. It can be enabled by setting them to `true` at the root level.
+Pruning is enabled by default for `go-tests` and `unused-packages`. It can disabled by removing those fields from the `[prune]` table at the root level. Pruning can be enabled for `non-go` by setting it to true at the root level.
+


I agree with @jmank88 . How about:

Pruning options are disabled by default. Generating a Gopkg.toml generate through dep init will enable go-tests and unused-packages prune options by default.

nhooyr · 2018-02-09T21:28:39Z

docs/Gopkg.toml.md

@@ -192,10 +192,12 @@ The following are the current available options:

 Out of an abundance of caution, dep non-optionally preserves files that may have legal significance.

-Pruning is disabled by default. It can be enabled by setting them to `true` at the root level.
+Pruning options are disabled by default. However, generating a `Gopkg.toml` via `dep init` will enable `go-tests` and `unused-packages` prune options by default.


I think

dep init will add lines to enable go-tests and unused-packages prune options by default.

is better, just so its clear its not magical.

What about:

However, generating a Gopkg.toml via dep init will add lines to enable go-tests and unused-packages ~~prune options by default~~.

Unless the trailing 'by default' is referring to how projects inherit from the root settings - In that case, I think 'at the root level' is more clear.

I think we should keep the prune options part and only remove the by default part.

ibrasho · 2018-02-19T19:26:43Z

@andrewjstone Could you please sign the CLA?

googlebot · 2018-02-20T20:43:23Z

CLAs look good, thanks!

googlebot · 2018-02-20T20:43:23Z

CLAs look good, thanks!

andrewjstone · 2018-02-20T20:45:12Z

I rebased to a single commit and changed my email address to my employer so the CLA would be signed.

andrewjstone requested a review from sdboyer as a code owner February 7, 2018 22:55

googlebot added the cla: no label Feb 7, 2018

jmank88 reviewed Feb 8, 2018

View reviewed changes

jmank88 mentioned this pull request Feb 8, 2018

pruning docs need update #1638

Closed

ibrasho suggested changes Feb 8, 2018

View reviewed changes

nhooyr suggested changes Feb 9, 2018

View reviewed changes

jmank88 mentioned this pull request Feb 15, 2018

Clarify prune documentation: enabled by default if you run dep init. #1687

Closed

Update docs to reflect default prune settings

3504ee1

andrewjstone force-pushed the fix-toml-prune-docs branch from 7beaccb to 3504ee1 Compare February 20, 2018 20:43

googlebot added cla: yes and removed cla: no labels Feb 20, 2018

sdboyer approved these changes Feb 21, 2018

View reviewed changes

sdboyer merged commit d87e823 into golang:master Feb 21, 2018

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update docs to reflect default prune settings #1650

Update docs to reflect default prune settings #1650

andrewjstone commented Feb 7, 2018

googlebot commented Feb 7, 2018

jmank88 Feb 8, 2018

ibrasho Feb 8, 2018

andrewjstone Feb 8, 2018

ibrasho Feb 8, 2018 •

edited

Loading

ibrasho Feb 8, 2018

nhooyr Feb 9, 2018 •

edited

Loading

philoserf Feb 10, 2018

jmank88 Feb 11, 2018

nhooyr Feb 11, 2018

ibrasho commented Feb 19, 2018

googlebot commented Feb 20, 2018

googlebot commented Feb 20, 2018

andrewjstone commented Feb 20, 2018

Update docs to reflect default prune settings #1650

Update docs to reflect default prune settings #1650

Conversation

andrewjstone commented Feb 7, 2018

What does this do / why do we need it?

What should your reviewer look out for in this PR?

Do you need help or clarification on anything?

Which issue(s) does this PR fix?

googlebot commented Feb 7, 2018

jmank88 Feb 8, 2018

Choose a reason for hiding this comment

ibrasho Feb 8, 2018

Choose a reason for hiding this comment

andrewjstone Feb 8, 2018

Choose a reason for hiding this comment

ibrasho Feb 8, 2018 • edited Loading

Choose a reason for hiding this comment

ibrasho Feb 8, 2018

Choose a reason for hiding this comment

nhooyr Feb 9, 2018 • edited Loading

Choose a reason for hiding this comment

philoserf Feb 10, 2018

Choose a reason for hiding this comment

jmank88 Feb 11, 2018

Choose a reason for hiding this comment

nhooyr Feb 11, 2018

Choose a reason for hiding this comment

ibrasho commented Feb 19, 2018

googlebot commented Feb 20, 2018

googlebot commented Feb 20, 2018

andrewjstone commented Feb 20, 2018

ibrasho Feb 8, 2018 •

edited

Loading

nhooyr Feb 9, 2018 •

edited

Loading