Bug 268829 - misc/freebsd-doc-all: missing styles; and for some languages, HTML files are missing
Summary: misc/freebsd-doc-all: missing styles; and for some languages, HTML files are ...
Status: Closed FIXED
Alias: None
Product: Ports & Packages
Classification: Unclassified
Component: Individual Port(s) (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Many People
Assignee: Danilo G. Baio
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2023-01-08 19:38 UTC by Graham Perrin
Modified: 2023-04-30 18:07 UTC (History)
6 users (show)

See Also:
dbaio: maintainer-feedback+


Attachments
Including styles patch (348 bytes, patch)
2023-03-29 23:40 UTC, Alex Bylund
no flags Details | Diff
Missing files (2.70 KB, text/plain)
2023-03-30 15:15 UTC, Alex Bylund
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Graham Perrin freebsd_committer freebsd_triage 2023-01-08 19:38:22 UTC
PDF alone can be a source of frustration, for example: 

% pkg provides /usr/local/share/doc/freebsd/en/books/
Name    : en-freebsd-doc-20221229,1
Comment : Documentation from the FreeBSD Documentation Project
Repo    : FreeBSD
Filename: usr/local/share/doc/freebsd/en/books/porters-handbook/porters-handbook_en.pdf
          usr/local/share/doc/freebsd/en/books/handbook/handbook_en.pdf
          usr/local/share/doc/freebsd/en/books/fdp-primer/fdp-primer_en.pdf
          usr/local/share/doc/freebsd/en/books/faq/faq_en.pdf
          usr/local/share/doc/freebsd/en/books/developers-handbook/developers-handbook_en.pdf
          usr/local/share/doc/freebsd/en/books/dev-model/dev-model_en.pdf
          usr/local/share/doc/freebsd/en/books/design-44bsd/design-44bsd_en.pdf
          usr/local/share/doc/freebsd/en/books/arch-handbook/arch-handbook_en.pdf
% pkg info --list misc/freebsd-doc-en | grep htm
% 


Reported by user Blank#0656 in Discord at and around: 

* <https://discord.com/channels/727023752348434432/757543661058654269/1060990352737189969>
* <https://discord.com/channels/727023752348434432/760416312676712519/1061606002220343366>
Comment 1 Graham Perrin freebsd_committer freebsd_triage 2023-03-04 08:51:47 UTC
Partly fixed by 65985e68b04ebc41504bf5a014b0ebdd2868fc54

<https://cgit.freebsd.org/ports/commit/?id=65985e68b04ebc41504bf5a014b0ebdd2868fc54>

> misc/freebsd-doc-*: Update to rev. db3bba9 from FreeBSD docset
> 
> - Reallow HTML build for en_US [1]

In context: 

misc/freebsd-doc-all
misc/freebsd-doc-bn
misc/freebsd-doc-da
misc/freebsd-doc-de
misc/freebsd-doc-el
misc/freebsd-doc-en
misc/freebsd-doc-es
misc/freebsd-doc-fr
misc/freebsd-doc-hu
misc/freebsd-doc-id
misc/freebsd-doc-it
misc/freebsd-doc-ja
misc/freebsd-doc-ko
misc/freebsd-doc-mn
misc/freebsd-doc-nl
misc/freebsd-doc-pl
misc/freebsd-doc-pt
misc/freebsd-doc-ru
misc/freebsd-doc-tr
misc/freebsd-doc-zh_cn
misc/freebsd-doc-zh_tw
Comment 2 Alex Bylund 2023-03-28 23:21:34 UTC
The styles directory and css files are also missing. /usr/local/share/doc/freebsd/styles

Example, in handbook/cutting-edge/index.html: ../../../styles/main.min.css

None of the pages are showing up styled.
Comment 3 Alex Bylund 2023-03-29 23:40:22 UTC
Created attachment 241195 [details]
Including styles patch

This fixes the missing styles as far as I can tell. I'm not familiar with how the documentations are all put together though.
Comment 4 Danilo G. Baio freebsd_committer freebsd_triage 2023-03-30 00:53:10 UTC
(In reply to Alex Bylund from comment #3)

Hi Alex.

This fixes the offline HTML for the assets available here [1]. 
I'll run some tests since some images are missing and then push this update.
Thanks.

But the ports/packages use a different approach [2], [3] to build.

And thank you for taking a look at this.

1 - https://download.freebsd.org/doc/
2 - https://ports.freebsd.org/cgi/ports.cgi?query=freebsd-doc&stype=all&sektion=all
3 - https://cgit.freebsd.org/ports/tree/misc/freebsd-doc-en

Regards.
Comment 5 Alex Bylund 2023-03-30 15:15:42 UTC
Created attachment 241209 [details]
Missing files

There are some more missing files that are preventing the package from being built.
Comment 6 Marc Fonvieille freebsd_committer freebsd_triage 2023-03-30 17:16:21 UTC
(In reply to Alex Bylund from comment #5)
I cannot reproduce the build failure, e.g., 
tar tvf en-freebsd-doc-20230224,1 | grep pam
-rw-r--r--  0 root   wheel   76239 31 mars 00:28 /usr/local/share/doc/freebsd/articles/pam/index.html
-rw-r--r--  0 root   wheel  375409 31 mars 00:28 /usr/local/share/doc/freebsd/en/articles/pam/pam_en.pdf
-rw-r--r--  0 root   wheel     3522 31 mars 00:28 /usr/local/share/doc/freebsd/en/articles/pam/converse.c
-rw-r--r--  0 root   wheel     4548 31 mars 00:28 /usr/local/share/doc/freebsd/en/articles/pam/pam_unix.c
-rw-r--r--  0 root   wheel     5185 31 mars 00:28 /usr/local/share/doc/freebsd/en/articles/pam/su.c

I get the files.
Comment 7 Marc Fonvieille freebsd_committer freebsd_triage 2023-03-30 17:18:30 UTC
(In reply to Alex Bylund from comment #3)
For those missing .css, the ports will be fixed once 13.2-R will be out.
Comment 8 Alex Bylund 2023-03-30 17:30:51 UTC
(In reply to Marc Fonvieille from comment #6)

From Makefile on line 33:

# HTML format disabled until separate localized-only build will work again

I tried building manually with "make package" - I'm thinking that's what localized-only build meant. In the Makefile also though, it always adds the extra plist file, which is not copying for some reason.
Comment 9 commit-hook freebsd_committer freebsd_triage 2023-03-31 00:26:13 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/doc/commit/?id=5795dee51d53fc90514fab34ea6dc1d29ca68555

commit 5795dee51d53fc90514fab34ea6dc1d29ca68555
Author:     Alex Bylund <notbylundzander@gmail.com>
AuthorDate: 2023-03-31 00:20:27 +0000
Commit:     Danilo G. Baio <dbaio@FreeBSD.org>
CommitDate: 2023-03-31 00:22:25 +0000

    documentation: Fix styles of the HTML offline assets

    PR:             268829
    Co-authored-by: Danilo G. Baio <dbaio@FreeBSD.org>

 documentation/tools/asciidoctor.sh | 3 +++
 1 file changed, 3 insertions(+)
Comment 10 Danilo G. Baio freebsd_committer freebsd_triage 2023-03-31 00:27:52 UTC
(In reply to Danilo G. Baio from comment #4)

This is done; thank you!
Comment 11 Marc Fonvieille freebsd_committer freebsd_triage 2023-04-02 15:14:30 UTC
The comment is not for the en_US version.
In my poudriere, same for the cluster package builder, the package's build does not fail.  I get the files for both HTML and PDF version in the built package.
So, I dunno :-)
Maybe, you should check if "make options" is Ok.
What is the result with poudriere?
E.g. with something like:
poudriere testport -k -j yourjail -p yourportstree -o misc/freebsd-doc-all
Comment 12 Marc Fonvieille freebsd_committer freebsd_triage 2023-04-10 16:04:51 UTC
(In reply to Marc Fonvieille from comment #11)
Hi,

Could you check
https://cgit.freebsd.org/ports/commit/?id=45f2c87fd5634fe77956949a011f82e06fbc504c
, please?
It should fix every problem you got.
Comment 13 Graham Perrin freebsd_committer freebsd_triage 2023-04-10 18:11:08 UTC
(In reply to Marc Fonvieille from comment #12)

Thanks, however I can't build on CURRENT at this time. From a run of poudriere:


[00:07:21] [02] [00:05:25] Finished www/gohugo | gohugo-0.111.3_1: Failed: fetch


(That's just FYI, if I need help with it I'll ask elsewhere.)
Comment 14 Graham Perrin freebsd_committer freebsd_triage 2023-04-10 19:47:01 UTC
(In reply to Marc Fonvieille from comment #12)

Four staging failures. At a glance, in each case: 

> … No such file or directory

Would you like me to attach the log files? 

de-freebsd-doc
fr-freebsd-doc
pt-freebsd-doc
ru-freebsd-doc
Comment 15 Marc Fonvieille freebsd_committer freebsd_triage 2023-04-11 06:28:24 UTC
(In reply to Graham Perrin from comment #14)
No, thanks :-)
I thought about it this night, my fix on en_US broke some other plists and since I forgot to flush poudriere before the build, I did not see it...
I'll fix it.
Comment 16 Marc Fonvieille freebsd_committer freebsd_triage 2023-04-11 19:25:21 UTC
(In reply to Marc Fonvieille from comment #15)
Should be fixed with last revision.
Comment 17 Danilo G. Baio freebsd_committer freebsd_triage 2023-04-30 18:07:05 UTC
Hi.

Please let us know if you still have issues with the last update. Thank you all.

misc/freebsd-doc-*: Enable HTML in all languages and Simplify ports
https://cgit.freebsd.org/ports/commit/?id=dad58c1094e9134cb8953630842987508483e43b