Page MenuHomeFreeBSD

misc/freebsd-doc-*: Enable HTML in all languages and Simplify ports
ClosedPublic

Authored by dbaio on Apr 18 2023, 12:11 AM.
Tags
None
Referenced Files
Unknown Object (File)
Tue, May 7, 12:05 AM
Unknown Object (File)
Tue, May 7, 12:04 AM
Unknown Object (File)
Tue, May 7, 12:04 AM
Unknown Object (File)
Tue, May 7, 12:04 AM
Unknown Object (File)
Tue, May 7, 12:04 AM
Unknown Object (File)
Sun, May 5, 4:45 PM
Unknown Object (File)
Sun, May 5, 6:52 AM
Unknown Object (File)
Fri, May 3, 9:57 AM

Details

Summary
misc/freebsd-doc-*: Enable HTML in all languages and Simplify ports

Several improvements with this change:

Overall cleanup.

Simplify plists.

Make the HTML option default for all languages.

Non-English ports must build the HTML English version together, and the
shared files are stored in the freebsd-doc-en port.

Fix some image's src addresses on freebsd-doc-en.

Point MASTER_SITES to LOCAL/doceng; it's a shared folder with the team.

It's necessary to choose at least one option.
Test Plan
  • All ports are installed locally and checked several HTML and PDF files.
  • Poudriere builds with default options, only PDF option and only HTML option.

Diff Detail

Repository
R11 FreeBSD ports repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

doceng

In our shared folder (at freefall), there is a script to help generate the tarballs; it basically does what @blackend said in one e-mail for us.

dbaio@freefall:~doceng/doc_releases $ pwd
/home/doceng/doc_releases

dbaio@freefall:~doceng/doc_releases $ ./generate_port_freebsd_doc_en_tarball.sh
[...]

Copy freebsd-doc-20230417.tar.gz into ~doceng/public_distfiles/
and wait for the sync:

cp freebsd-doc-20230417.tar.gz ~doceng/public_distfiles/
misc/freebsd-doc-en/Makefile
50–52

I'll remove this after upstream the config to the doc repo.

misc/freebsd-doc-en/Makefile
90

We agree that extras files are not installed with PDF version, are we?

until hugo doesn't allow disabling the default language, yes

misc/freebsd-doc-en/Makefile
90

Hi @blackend, thanks for taking a look at this review.

The articles freebsd-update-server and pam only have source files.

When people are offline browsing, the HTML links will work locally, but most PDF links won't. I don't think it's necessary to copy those source files within the PDF.

However, if you believe it is important, I can put them back. In any case, all common and extra files will be installed within the HTML version, which will be enabled by default with this change.

Regards.

  • Update to 20230420 and remove tests
misc/freebsd-doc-bn/Makefile
11

I'm not sure to understand the need of this for PDF version since localized PDF can be built and used w/o en_US version.
So maybe
.if ${PORT_OPTIONS:MHTML}
RUN_DEPENDS= ...
.endif
should be good.

  • Make en-freebsd-doc dependent only when using the HTML option; Simplify plists

    For some reason, the ports were not handling plists correctly (not only with this change).
	 So I've cleaned up the plists, unified them, and added the port option
    (HTML or PDF) on each file.

    This makes freebsd-doc-* ports simpler.

Make en-freebsd-doc dependent only when using the HTML option; Simplify plists

For some reason, the ports were not handling plists correctly (not only with this change).

So I've cleaned up the plists, unified them, and added the port option (HTML or PDF) on each file.

This makes freebsd-doc-* ports simpler.

dbaio retitled this revision from misc/freebsd-doc-*: Enable HTML in all languages to misc/freebsd-doc-*: Enable HTML in all languages and Simplify ports.Apr 21 2023, 9:19 PM
dbaio edited the summary of this revision. (Show Details)
dbaio edited the test plan for this revision. (Show Details)

Thanks for this huge work!

This revision is now accepted and ready to land.Apr 24 2023, 9:35 AM