Skip to content

Commit

Permalink
doc: fixup generated documentation files after removing dispatcher flags
Browse files Browse the repository at this point in the history
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`.
  • Loading branch information
matzf committed May 23, 2024
1 parent c43edd7 commit 0325ae2
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 11 deletions.
2 changes: 1 addition & 1 deletion .bazelrc
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ test:unit_all --config=unit //...
test:integration --test_tag_filters=integration,-lint
test:integration_all --config=integration //...

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

# run quietly, only display errors
common:quiet --ui_event_filters=-warning,-info,-debug,-stdout,-stderr --noshow_progress
1 change: 0 additions & 1 deletion doc/command/scion-pki/scion-pki_certificate_renew.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,6 @@ Options
--ca is mutually exclusive with --remote
--common-name string The common name that replaces the common name in the subject template
--curve string The elliptic curve to use (P-256|P-384|P-521) (default "P-256")
--dispatcher string Path to the dispatcher socket (default "/run/shm/dispatcher/default.sock")
--expires-in string Remaining time threshold for renewal
--features strings enable development features ()
--force Force overwritting existing files
Expand Down
11 changes: 5 additions & 6 deletions doc/command/scion/scion_address.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,11 @@ Options

::

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

SEE ALSO
~~~~~~~~
Expand Down
1 change: 0 additions & 1 deletion doc/command/scion/scion_ping.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,6 @@ Options
::

-c, --count uint16 total number of packets to send
--dispatcher string Path to the dispatcher socket (default "/run/shm/dispatcher/default.sock")
--epic Enable EPIC for path probing.
--format string Specify the output format (human|json|yaml) (default "human")
--healthy-only only use healthy paths
Expand Down
1 change: 0 additions & 1 deletion doc/command/scion/scion_showpaths.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,6 @@ Options

::

--dispatcher string Path to the dispatcher socket (default "/run/shm/dispatcher/default.sock")
--epic Enable EPIC.
-e, --extended Show extended path meta data information
--format string Specify the output format (human|json|yaml) (default "human")
Expand Down
1 change: 0 additions & 1 deletion doc/command/scion/scion_traceroute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,6 @@ Options

::

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

0 comments on commit 0325ae2

Please sign in to comment.