Skip to content

Commit 451f97e

Browse files
committed
Auto merge of #6459 - ehuss:fix-man-checks, r=alexcrichton
Fix new man page links. The rustc link checker found some problems: - The raw generated HTML files were being included when they shouldn't. Fixed by moving them out of the mdbook directory. - The `print.html` file concatenates all the pages together, causing duplicate `id`'s. Fix by giving each page a unique set of IDs.
2 parents 8ffc960 + 4338d34 commit 451f97e

File tree

119 files changed

+521
-492
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

119 files changed

+521
-492
lines changed

src/doc/Makefile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
# format. See https://asciidoctor.org/ for more information.
55
#
66
# Just run `make` and it will generate the man pages in src/etc/man and the
7-
# HTML pages in src/doc/src/commands/generated.
7+
# HTML pages in src/doc/man/generated.
88
#
99
# There are some Asciidoctor extensions, see the file `asciidoc-extensions.rb`
1010
# for the documentation.
1111

1212
MAN_SOURCE = $(sort $(wildcard man/cargo*.adoc))
1313
COMMANDS = $(notdir $(MAN_SOURCE))
14-
HTML = $(patsubst %.adoc,src/commands/generated/%.html,$(COMMANDS))
14+
HTML = $(patsubst %.adoc,man/generated/%.html,$(COMMANDS))
1515
MAN_LOCATION = ../etc/man
1616
MAN = $(patsubst %.adoc,$(MAN_LOCATION)/%.1,$(COMMANDS))
1717
ASCIIDOCOPTS = -r ./asciidoc-extension.rb
@@ -21,7 +21,7 @@ all: commands-html man
2121
commands-html: $(HTML)
2222
man: $(MAN)
2323

24-
$(HTML): src/commands/generated/%.html : man/%.adoc asciidoc-extension.rb $(OTHER_DEPS)
24+
$(HTML): man/generated/%.html : man/%.adoc asciidoc-extension.rb $(OTHER_DEPS)
2525
asciidoctor $(ASCIIDOCOPTS) -s $< -o $@
2626

2727
$(MAN): $(MAN_LOCATION)/%.1 : man/%.adoc $(OTHER_DEPS)

src/doc/man/cargo-bench.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= cargo-bench(1)
2+
:idprefix: cargo_bench_
23
:doctype: manpage
34
:actionverb: Benchmark
45
:nouns: benchmarks

src/doc/man/cargo-build.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= cargo-build(1)
2+
:idprefix: cargo_build_
23
:doctype: manpage
34
:actionverb: Build
45

src/doc/man/cargo-check.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= cargo-check(1)
2+
:idprefix: cargo_check_
23
:doctype: manpage
34
:actionverb: Check
45

src/doc/man/cargo-clean.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= cargo-clean(1)
2+
:idprefix: cargo_clean_
23
:doctype: manpage
34
:actionverb: Clean
45

src/doc/man/cargo-doc.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= cargo-doc(1)
2+
:idprefix: cargo_doc_
23
:doctype: manpage
34
:actionverb: Document
45

src/doc/man/cargo-fetch.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= cargo-fetch(1)
2+
:idprefix: cargo_fetch_
23
:doctype: manpage
34
:actionverb: Fetch
45

src/doc/man/cargo-fix.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= cargo-fix(1)
2+
:idprefix: cargo_fix_
23
:doctype: manpage
34
:actionverb: Fix
45

src/doc/man/cargo-generate-lockfile.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= cargo-generate-lockfile(1)
2+
:idprefix: cargo_generate-lockfile_
23
:doctype: manpage
34

45
== NAME

src/doc/man/cargo-help.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= cargo-help(1)
2+
:idprefix: cargo_help_
23
:doctype: manpage
34

45
== NAME

0 commit comments

Comments
 (0)