From owner-dev-commits-ports-all@freebsd.org Sat Aug 28 13:17:38 2021 Return-Path: Delivered-To: dev-commits-ports-all@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id 14D04674242; Sat, 28 Aug 2021 13:17:38 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4GxcZT0CJGz4SD5; Sat, 28 Aug 2021 13:17:36 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 6A0C117B46; Sat, 28 Aug 2021 13:17:36 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 17SDHaFE028365; Sat, 28 Aug 2021 13:17:36 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 17SDHaZA028364; Sat, 28 Aug 2021 13:17:36 GMT (envelope-from git) Date: Sat, 28 Aug 2021 13:17:36 GMT Message-Id: <202108281317.17SDHaZA028364@gitrepo.freebsd.org> To: ports-committers@FreeBSD.org, dev-commits-ports-all@FreeBSD.org, dev-commits-ports-main@FreeBSD.org From: Jan Beich Subject: git: 0df0f539c232 - main - x11/wezterm: install documentation MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: jbeich X-Git-Repository: ports X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 0df0f539c23207b996fdc8b4a97fe1354cab4474 Auto-Submitted: auto-generated X-BeenThere: dev-commits-ports-all@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Commit messages for all branches of the ports repository List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 28 Aug 2021 13:17:38 -0000 The branch main has been updated by jbeich: URL: https://cgit.FreeBSD.org/ports/commit/?id=0df0f539c23207b996fdc8b4a97fe1354cab4474 commit 0df0f539c23207b996fdc8b4a97fe1354cab4474 Author: Jan Beich AuthorDate: 2021-08-28 11:53:54 +0000 Commit: Jan Beich CommitDate: 2021-08-28 13:17:21 +0000 x11/wezterm: install documentation Increases install size by ~70 MiB but there're no manpages. --- x11/wezterm/Makefile | 21 ++++++++++++++++++++- x11/wezterm/files/patch-docs | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 53 insertions(+), 1 deletion(-) diff --git a/x11/wezterm/Makefile b/x11/wezterm/Makefile index ae193b6b4e46..6e3956574c17 100644 --- a/x11/wezterm/Makefile +++ b/x11/wezterm/Makefile @@ -1,6 +1,6 @@ PORTNAME= wezterm DISTVERSION= 20210814-124438-54e29167 -PORTREVISION= 2 +PORTREVISION= 3 CATEGORIES= x11 MAINTAINER= jbeich@FreeBSD.org @@ -546,6 +546,12 @@ CARGO_USE_GITHUB= yes # XXX https://github.com/rust-lang/cargo/issues/4101 CARGO_INSTALL_PATH= ${PLIST_FILES:Mbin/*:T} +OPTIONS_DEFINE= DOCS + +DOCS_BUILD_DEPENDS= mdbook:textproc/mdbook \ + mdbook-linkcheck:textproc/mdbook-linkcheck +PORTDOCS= html + post-patch: # Extract (snapshot) version from the port instead of .tag file @${ECHO_CMD} '${DISTVERSIONFULL}' >${WRKSRC}/.tag @@ -553,6 +559,19 @@ post-patch: @${REINPLACE_CMD} -e 's/"python3"/"${PYTHON_CMD:T}"/' \ ${WRKSRC}/cargo-crates/xcb-*/build.rs +do-build-DOCS-on: +# Build HTML documentation similar to ci/build-docs.sh + (cd ${WRKSRC} && ${PYTHON_CMD} ci/generate-docs.py) + mdbook build ${WRKSRC}/docs + ${CP} ${WRKSRC}/assets/icon/terminal.png \ + ${WRKSRC}/gh_pages/html/favicon.png + ${CP} ${WRKSRC}/assets/icon/${PORTNAME}-icon.svg \ + ${WRKSRC}/gh_pages/html/favicon.svg + +do-install-DOCS-on: + (cd ${WRKSRC}/gh_pages && ${COPYTREE_SHARE} \ + "${PORTDOCS:Mhtml}" ${STAGEDIR}${DOCSDIR}) + post-install: # Install assets similar to ci/deploy.sh .for f in ${PORTNAME}.desktop ${PORTNAME}.appdata.xml \ diff --git a/x11/wezterm/files/patch-docs b/x11/wezterm/files/patch-docs new file mode 100644 index 000000000000..4201001c8ec4 --- /dev/null +++ b/x11/wezterm/files/patch-docs @@ -0,0 +1,33 @@ +Drop installation chapter as it requires network during build + +--- ci/generate-docs.py.orig 2021-08-14 19:44:38 UTC ++++ ci/generate-docs.py +@@ -114,17 +114,6 @@ TOC = [ + "wezterm", + "index.md", + children=[ +- Page( +- "Install", +- "installation.md", +- children=[ +- Page("Windows", "install/windows.md"), +- Page("macOS", "install/macos.md"), +- Page("Linux", "install/linux.md"), +- Page("FreeBSD", "install/freebsd.md"), +- Page("Build from source", "install/source.md"), +- ], +- ), + Page("Features", "features.md"), + Page("Change Log", "changelog.md"), + Page( +--- docs/contributing.md.orig 2021-08-14 19:44:38 UTC ++++ docs/contributing.md +@@ -8,7 +8,7 @@ If you're thinking of helping out, then the following + * [WezTerm on GitHub](https://github.com/wez/wezterm) + * [GitHub Discussions](https://github.com/wez/wezterm/discussions) + * [Realtime conversation with wez on Element.io/Gitter](help.html) +-* [Building from Source](install/source.html) ++* [Building from Source](https://github.com/wez/wezterm/blob/main/docs/install/source.markdown) + * [Where to find things and hacking on wezterm](https://github.com/wez/wezterm/blob/master/CONTRIBUTING.md#contributing-to-wezterm) + + I like to think that I have an open mind and I try to be open to ideas,