Skip to content

Commit 8c2b179

Browse files
aduh95targos
authored andcommitted
doc: recommend test-doc instead of lint-md
The documentation style guide used to recommend checking changes in the docs by running `make lint-md`. This leaves out some important checks which are contained in the `test-doc` build target. This commit also replaces `lint` by `lint-md` in the list of `test-doc`'s prerequisites. PR-URL: #35708 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com>
1 parent a5fa849 commit 8c2b179

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -580,7 +580,7 @@ test-hash-seed: all
580580
$(NODE) test/pummel/test-hash-seed.js
581581

582582
.PHONY: test-doc
583-
test-doc: doc-only lint ## Builds, lints, and verifies the docs.
583+
test-doc: doc-only lint-md ## Builds, lints, and verifies the docs.
584584
@if [ "$(shell $(node_use_openssl))" != "true" ]; then \
585585
echo "Skipping test-doc (no crypto)"; \
586586
else \

doc/guides/doc-style-guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ this guide.
1616
* Documents should be word-wrapped at 80 characters.
1717
* `.editorconfig` describes the preferred formatting.
1818
* A [plugin][] is available for some editors to apply these rules.
19-
* Check changes to documentation with `make lint-md`.
19+
* Check changes to documentation with `make test-doc -j` or `vcbuild test-doc`.
2020
* [Use US spelling][].
2121
* [Use serial commas][].
2222
* Avoid first-person pronouns (_I_, _we_).

0 commit comments

Comments
 (0)