Skip to content

Commit 563aba2

Browse files
authored
doc: fixup generated documentation files after removing dispatcher flags (scionproto#4529)
Run `bazel run //:write_all_source_files` to fix up generated documentation after removing the dispatcher flag from scion/scion-pki binaries. This was missed during the PR because the existing check for this was not active in the CI. Extend the bazel configuration `test:lint` to enable running this in `make lint`.
1 parent c43edd7 commit 563aba2

File tree

6 files changed

+6
-11
lines changed

6 files changed

+6
-11
lines changed

.bazelrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ test:unit_all --config=unit //...
3535
test:integration --test_tag_filters=integration,-lint
3636
test:integration_all --config=integration //...
3737

38-
test:lint --test_tag_filters=lint --test_summary=terse --noshow_progress --experimental_convenience_symlinks=ignore
38+
test:lint --test_tag_filters=lint,write_src --test_summary=terse --noshow_progress --experimental_convenience_symlinks=ignore
3939

4040
# run quietly, only display errors
4141
common:quiet --ui_event_filters=-warning,-info,-debug,-stdout,-stderr --noshow_progress

doc/command/scion-pki/scion-pki_certificate_renew.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,6 @@ Options
120120
--ca is mutually exclusive with --remote
121121
--common-name string The common name that replaces the common name in the subject template
122122
--curve string The elliptic curve to use (P-256|P-384|P-521) (default "P-256")
123-
--dispatcher string Path to the dispatcher socket (default "/run/shm/dispatcher/default.sock")
124123
--expires-in string Remaining time threshold for renewal
125124
--features strings enable development features ()
126125
--force Force overwritting existing files

doc/command/scion/scion_address.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,11 @@ Options
3535

3636
::
3737

38-
--dispatcher string Path to the dispatcher socket (default "/run/shm/dispatcher/default.sock")
39-
-h, --help help for address
40-
--isd-as isd-as The local ISD-AS to use. (default 0-0)
41-
--json Write the output as machine readable json
42-
-l, --local ip Local IP address to listen on. (default invalid IP)
43-
--sciond string SCION Daemon address. (default "127.0.0.1:30255")
38+
-h, --help help for address
39+
--isd-as isd-as The local ISD-AS to use. (default 0-0)
40+
--json Write the output as machine readable json
41+
-l, --local ip Local IP address to listen on. (default invalid IP)
42+
--sciond string SCION Daemon address. (default "127.0.0.1:30255")
4443

4544
SEE ALSO
4645
~~~~~~~~

doc/command/scion/scion_ping.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,6 @@ Options
8787
::
8888

8989
-c, --count uint16 total number of packets to send
90-
--dispatcher string Path to the dispatcher socket (default "/run/shm/dispatcher/default.sock")
9190
--epic Enable EPIC for path probing.
9291
--format string Specify the output format (human|json|yaml) (default "human")
9392
--healthy-only only use healthy paths

doc/command/scion/scion_showpaths.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,6 @@ Options
9090

9191
::
9292

93-
--dispatcher string Path to the dispatcher socket (default "/run/shm/dispatcher/default.sock")
9493
--epic Enable EPIC.
9594
-e, --extended Show extended path meta data information
9695
--format string Specify the output format (human|json|yaml) (default "human")

doc/command/scion/scion_traceroute.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,6 @@ Options
7979

8080
::
8181

82-
--dispatcher string Path to the dispatcher socket (default "/run/shm/dispatcher/default.sock")
8382
--epic Enable EPIC.
8483
--format string Specify the output format (human|json|yaml) (default "human")
8584
-h, --help help for traceroute

0 commit comments

Comments
 (0)