Bug 274073

Summary: documentation/Makefile: ambiguous target: all
Product: Documentation Reporter: Graham Perrin <grahamperrin>
Component: Books & ArticlesAssignee: Sergio Carlavilla Delgado <carlavilla>
Status: Closed FIXED    
Severity: Affects Some People CC: carlavilla, doc
Priority: --- Keywords: needs-qa
Version: Latest   
Hardware: Any   
OS: Any   
URL: https://github.com/freebsd/freebsd-doc/blob/8b69e0b9bdd4f902d7d1d9acd0b15f7542de6470/documentation/Makefile#L6-L18

Description Graham Perrin 2023-09-25 06:55:41 UTC
Lines 6--8: 

# Targets intended for use on the command line
#
# all (default)	-	generate the books TOC and compile all the documentation

I assumed that 'all' would include the 'pdf' target at line 11. 

From attachment 245207 [details] (with make DOC_LANG=en), and from what's below, it seems not. 

Please, what's the meaning of all, here?

----% cd /usr/doc/documentation && make clean
rm -rf resources public
rm -f static/pgpkeys/pgpkeys.txt
% make DOC_LANG=en all
---------------------------------------------------------------
Building the documentation
included languages: en
excluded languages: bn-bd da de el es fr hu id it ja ko mn nl pl pt-br ru tr zh-cn zh-tw
---------------------------------------------------------------
/usr/local/bin/ruby ./tools/global-pgpkeys-creator.rb
HUGO_DISABLELANGUAGES=" bn-bd da de el es fr hu id it ja ko mn nl pl pt-br ru tr zh-cn zh-tw" /usr/local/bin/hugo --minify
WARN  DEPRECATED: Kind "taxonomyterm" used in disableKinds is deprecated, use "taxonomy" instead.
WARN  Unknown kind "list" in outputs configuration.
WARN  Unknown kind "single" in outputs configuration.
Start building sites … 
hugo v0.118.2+extended freebsd/amd64 BuildDate=2023-09-02T09:28:48Z+0000 VendorInfo=freebsd


                   |  EN   
-------------------+-------
  Pages            | 1177  
  Paginator pages  |    0  
  Non-page files   |    0  
  Static files     |  825  
  Processed images |    0  
  Aliases          |    1  
  Sitemaps         |    2  
  Cleaned          |    0  

Total in 91458 ms
% find /usr/doc/documentation/public -name *.pdf* -print
find: No match.
%
Comment 1 commit-hook freebsd_committer freebsd_triage 2023-09-27 17:34:05 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/doc/commit/?id=588e1d119e47465bf132dd33093294d363a125fe

commit 588e1d119e47465bf132dd33093294d363a125fe
Author:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
AuthorDate: 2023-09-27 17:32:55 +0000
Commit:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
CommitDate: 2023-09-27 17:32:55 +0000

    Documentation Portal - Makefile: Improve all target comment

    PR:             274073
    Sponsored by:   Daifressh

 documentation/Makefile | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)
Comment 2 Graham Perrin 2023-10-01 11:00:51 UTC
(In reply to commit-hook from comment #1)

This commit lacked appropriate metadata, 

Reported-by: 

<https://docs.freebsd.org/en/articles/committers-guide/#_include_appropriate_metadata_in_a_footer>