Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs re: target tag usage #7360

Merged
merged 5 commits into from Mar 13, 2019

Conversation

Projects
None yet
4 participants
@codealchemy
Copy link
Contributor

commented Mar 11, 2019

Followup to #7315 (review)

cc: @baroquebobcat

@Eric-Arellano
Copy link
Contributor

left a comment

Thanks for adding this!

I'm not certain how I would add tags to pants.ini or a json file. Specifically, where would this go in pants.ini, i.e. what header? Maybe an example like

# pants.ini
...

[tags]
'skip-lint': ["path/to/target:", "path/to/another/target:bar"]

...

--

For Json file, I think it would help to explicitly show how to do both command line options and reference to pants.ini. Examples like this would help.

To link to this as a command line option, you'd run: ./pants ...`

To link to this in pants.ini:

# pants.ini
...

[tags]
path-to-json: config.json

...
@codealchemy

This comment has been minimized.

Copy link
Contributor Author

commented Mar 11, 2019

@Eric-Arellano I've added some more examples - and linked through to the options docs which covers how to configure options more in depth. Not sure how specific we'd need to be here, hopefully this makes things a bit clearer.

@Eric-Arellano
Copy link
Contributor

left a comment

Perfect! Thank you for adding that.

Also I think you can add ini as the language for your pants.ini example. Github recognizes it at least. Not sure how we make our docs if it would work.

@baroquebobcat
Copy link
Contributor

left a comment

Thanks. It looks pretty good. I have one minor suggestion.

Show resolved Hide resolved src/docs/build_files.md Outdated

baroquebobcat and others added some commits Mar 11, 2019

Update src/docs/build_files.md
Be more specific in referencing the BUILD file example

Co-Authored-By: codealchemy <codealchemy@users.noreply.github.com>

@benjyw benjyw merged commit 9aa7553 into pantsbuild:master Mar 13, 2019

1 check was pending

continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.