Makefile: add a check target

Add a `check' target to the Makefile, to run verifications on the
repository. Run the sphinx `linkcheck' step in there for the moment.

Update the CI to call `make check' instead of directly calling sphinx
`linkcheck'.

Mention this `make check' verification in CONTRIBUTING.

Signed-off-by: Vincent Stehlé <[email protected]>

.github/workflows/main.yaml

@@ -39,8 +39,8 @@ jobs:
           pip3 install --user typing
           pip3 install --user Sphinx
 
-      - name: 'Check links'
-        run: make linkcheck
+      - name: 'Check'
+        run: make check
 
       - name: 'Build PDF'
         run: |

CONTRIBUTING.rst

@@ -7,6 +7,7 @@ https://github.com/ARM-software/ebbr
 Anyone may contribute to the EBBR project.
 Contributions are licensed under CC-BY-SA-4.0_ and must be made with a
 Developer Certificate of Origin (DCO_) attestation as described below.
+It is recommended to run ``make check`` before sending patches.
 
 EBBR discussion uses the boot-architecture_ mailing list.
 

Makefile

@@ -11,8 +11,13 @@ BUILDDIR      = build
 # Put it first so that "make" without argument is like "make help".
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@echo
+	@echo 'Use "make check" to perform verifications on this repository.'
 
-.PHONY: help Makefile
+.PHONY: help Makefile check
+
+check:
+	$(SPHINXBUILD) -M linkcheck "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).

README.rst

@@ -103,6 +103,10 @@ To generate a single HTML page::
 
 Output goes in ``./build`` subdirectory.
 
+To run verifications on this repository::
+
+  $ make check
+
 To get some help on the available targets::
 
   $ make help