From nobody Sun Sep 22 17:35:41 2024 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4XBYDs4j96z5WYL4 for ; Sun, 22 Sep 2024 17:35:41 +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 "R11" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4XBYDs2dTkz4NQr; Sun, 22 Sep 2024 17:35:41 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1727026541; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=hXJpCXijz+js0evWHaG24cPZGAtP3h6TfznfsoQnY7s=; b=aJnEqjOXXDqvcduTYLdiof5xL43NJZgg+L24p1XH6LXmO6vZaVe1NRHxMTmSKugfYsvbL1 wkuMwcIJXC7aNxHsg3FSpxdIG8zNSYRG4fCwFzKda06UtIXE6SQqX/wTBl9iA5e3gehNlK 35iUf1xRfqloZcJTChEQ9BGJeq6pFbZk4VJxO8vfDuJC7GA5mhjt83vkOLY/VM9x0CVTug 0ALcFc55r9oj6By9q/3Lt5WB8TLBeU+B3HFVlSVXhdaTIejue6TrSvGP4fR7fMxKdegdHY bqEBm8vc7W37gVSGm0uW7MV1Qo9lcGv8up59gm7oBqXAO3CJB1yXpY/gJMLpGQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1727026541; a=rsa-sha256; cv=none; b=Ytz9Jr/IIHjaFe3QNhSoEmhfWHkcdD1t9J4a0dVxeANBciAUhqr36iin4RuwCk1Ippuy2g BE4nVZBIN/32yBwgW6H2xNwO+eB8cbd31/Ej24GzJxhXeL6eBfJTnj9eZeiAmJABj5ShQA JRStF2OJhxryO7fAVyHcAZ0PA02qArG2Vv9znxpyGwMQyXQjlSZ4XyM3X2MUWHk4AoRyKA WIggCRdpfAQS61ZgOQLxXCDyixY9smzb2R/vPz26gxPGWoXp2eriEw++M1iH+sPK3Xol8E N2hT9dn9T7U9yZl+FqrV0/Hlk+Qrn2nuzUXo71W5KvPFyG8RYhelUUuycrQm6Q== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1727026541; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=hXJpCXijz+js0evWHaG24cPZGAtP3h6TfznfsoQnY7s=; b=kBYYtjXFim3lAa3w1CJJ6H+frwfUfsGz+/OYIiOiPVJ/ecjlH2WXX57OR6CmHcSYKjFoGy BSr/JeMemKg6qPHOL3AWQrNdidSuC9SUBkmNWUBaaW204wgpt6xKxCv5nGeMiheBtLzu4x gfC+T08EcODzqAt7fD7Rl+mZW/Xg8wWAMZanvC6gaeUz3ib/YfjQu8vIpBvXYT7C56JbAn e+cZ1ja7wxqriU5gF5n5316aWOZsM9di6ymNPfb/pRgly3PiSihO4t7tpCitBuRDctGsmJ /+9OQ7/BaGJBPb+eX/5IBK+Wa38NAqwD4n4/NF6zoalTjDq6gGx26ZRurx299w== 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 4XBYDs2FBmz1Q2B; Sun, 22 Sep 2024 17:35:41 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 48MHZfhF019556; Sun, 22 Sep 2024 17:35:41 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 48MHZf84019553; Sun, 22 Sep 2024 17:35:41 GMT (envelope-from git) Date: Sun, 22 Sep 2024 17:35:41 GMT Message-Id: <202409221735.48MHZf84019553@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Fernando =?utf-8?Q?Apestegu=C3=ADa?= Subject: git: 7c2eef6968 - main - macros: Disallow crossref without description List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-doc-all@freebsd.org Sender: owner-dev-commits-doc-all@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: fernape X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 7c2eef6968d54237a82be653f14b712f574b97fa Auto-Submitted: auto-generated The branch main has been updated by fernape: URL: https://cgit.FreeBSD.org/doc/commit/?id=7c2eef6968d54237a82be653f14b712f574b97fa commit 7c2eef6968d54237a82be653f14b712f574b97fa Author: Fernando Apesteguía AuthorDate: 2024-09-22 17:30:45 +0000 Commit: Fernando Apesteguía CommitDate: 2024-09-22 17:35:28 +0000 macros: Disallow crossref without description While here, fix the macro documentation in fdp-primer. --- .../content/en/books/fdp-primer/asciidoctor-primer/_index.adoc | 2 +- shared/lib/InterDocumentReferencesMacro/extension.rb | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/documentation/content/en/books/fdp-primer/asciidoctor-primer/_index.adoc b/documentation/content/en/books/fdp-primer/asciidoctor-primer/_index.adoc index 12b3f4421f..a808ca8be0 100644 --- a/documentation/content/en/books/fdp-primer/asciidoctor-primer/_index.adoc +++ b/documentation/content/en/books/fdp-primer/asciidoctor-primer/_index.adoc @@ -252,7 +252,7 @@ Books are structured in different directories to keep a sane layout. To create a link from one subdirectory of a book to another subdirectory of the same book, use the `crossref` macro: .... -crossref:doc-build[documentation-makefile] +crossref:doc-build[documentation-makefile, This link] .... And this would be rendered as diff --git a/shared/lib/InterDocumentReferencesMacro/extension.rb b/shared/lib/InterDocumentReferencesMacro/extension.rb index fc6ca4e76a..da18d39935 100644 --- a/shared/lib/InterDocumentReferencesMacro/extension.rb +++ b/shared/lib/InterDocumentReferencesMacro/extension.rb @@ -12,6 +12,10 @@ class InterDocumentReferencesMacro < Asciidoctor::Extensions::InlineMacroProcess anchor = attrs[1] text = attrs[2] + if text.nil? || text.empty? + raise StandardError, "Crossref needs a description." + end + doc = parent.document if doc.backend == 'html5'