Skip to content

Commit e6db727

Browse files
Merge pull request #20 from Tinder/update_readme_v3
Readme updates
2 parents acb7791 + f985b74 commit e6db727

File tree

1 file changed

+30
-6
lines changed

1 file changed

+30
-6
lines changed

README.md

+30-6
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,16 @@ Open `bazel-diff-example.sh` to see how this is implemented. This is purely an e
5858

5959
`bazel-diff` Command
6060
~~~
61-
Usage: bazel-diff [-htV] -b=<bazelPath> [-fh=<finalHashesJSONPath>]
62-
[-o=<outputPath>] [-sh=<startingHashesJSONPath>]
61+
Usage: bazel-diff [-htV] -b=<bazelPath> [-co=<bazelCommandOptions>]
62+
[-fh=<finalHashesJSONPath>] [-o=<outputPath>]
63+
[-sh=<startingHashesJSONPath>] [-so=<bazelStartupOptions>]
6364
-w=<workspacePath> [COMMAND]
6465
Writes to a file the impacted targets between two Bazel graph JSON files
6566
-b, --bazelPath=<bazelPath>
6667
Path to Bazel binary
68+
-co, --bazelCommandOptions=<bazelCommandOptions>
69+
Additional space separated Bazel command options used when
70+
invoking Bazel
6771
-fh, --finalHashes=<finalHashesJSONPath>
6872
The path to the JSON file of target hashes for the final
6973
revision. Run 'generate-hashes' to get this value.
@@ -74,6 +78,9 @@ Writes to a file the impacted targets between two Bazel graph JSON files
7478
-sh, --startingHashes=<startingHashesJSONPath>
7579
The path to the JSON file of target hashes for the initial
7680
revision. Run 'generate-hashes' to get this value.
81+
-so, --bazelStartupOptions=<bazelStartupOptions>
82+
Additional space separated Bazel client startup options used
83+
when invoking Bazel
7784
-t, --tests Return only targets of kind 'test')
7885
-V, --version Print version information and exit.
7986
-w, --workspacePath=<workspacePath>
@@ -82,37 +89,54 @@ Writes to a file the impacted targets between two Bazel graph JSON files
8289

8390
`modified-filepaths` Command
8491
~~~
85-
Usage: bazel-diff modified-filepaths [-hV] -b=<bazelPath> -w=<workspacePath>
86-
<startingGitRevision> <endingGitRevision>
87-
<outputPath>
92+
Usage: bazel-diff modified-filepaths [-hV] -b=<bazelPath>
93+
[-co=<bazelCommandOptions>]
94+
[-so=<bazelStartupOptions>]
95+
-w=<workspacePath> <startingGitRevision>
96+
<endingGitRevision> <outputPath>
8897
Writes to the file the modified filepaths between two revisions.
8998
<startingGitRevision> The starting Git revision, e.g. "HEAD^"
9099
<endingGitRevision> The final Git revision, e.g. "HEAD"
91100
<outputPath> Path that the list of modified files will be
92101
written to
93102
-b, --bazelPath=<bazelPath>
94103
Path to Bazel binary
104+
-co, --bazelCommandOptions=<bazelCommandOptions>
105+
Additional space separated Bazel command options
106+
used when invoking Bazel
95107
-h, --help Show this help message and exit.
108+
-so, --bazelStartupOptions=<bazelStartupOptions>
109+
Additional space separated Bazel client startup
110+
options used when invoking Bazel
96111
-V, --version Print version information and exit.
97112
-w, --workspacePath=<workspacePath>
98113
Path to Bazel workspace directory.
99114
~~~
100115

101116
`generate-hashes` Command
102117
~~~
103-
Usage: bazel-diff generate-hashes [-hV] -b=<bazelPath> [-m=<modifiedFilepaths>]
118+
Usage: bazel-diff generate-hashes [-hV] -b=<bazelPath>
119+
[-co=<bazelCommandOptions>]
120+
[-m=<modifiedFilepaths>]
121+
[-so=<bazelStartupOptions>]
104122
-w=<workspacePath> <outputPath>
105123
Writes to a file the SHA256 hashes for each Bazel Target in the provided
106124
workspace.
107125
<outputPath> The filepath to write the resulting JSON of dictionary
108126
target => SHA-256 values
109127
-b, --bazelPath=<bazelPath>
110128
Path to Bazel binary
129+
-co, --bazelCommandOptions=<bazelCommandOptions>
130+
Additional space separated Bazel command options used when
131+
invoking Bazel
111132
-h, --help Show this help message and exit.
112133
-m, --modifiedFilepaths=<modifiedFilepaths>
113134
The path to a file containing the list of modified
114135
filepaths in the workspace, you can use the
115136
'modified-filepaths' command to get this list
137+
-so, --bazelStartupOptions=<bazelStartupOptions>
138+
Additional space separated Bazel client startup options
139+
used when invoking Bazel
116140
-V, --version Print version information and exit.
117141
-w, --workspacePath=<workspacePath>
118142
Path to Bazel workspace directory.

0 commit comments

Comments
 (0)