git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 2/2] Documentation: remove Asciidoctor linkgit macro

From
brian m. carlson <sandals@crustytoothpaste.net>
Date
Oct 27, 2014, 00:13 UTC
Message-ID
<1414368823-427216-3-git-send-email-sandals@crustytoothpaste.net>
In-Reply-To
<1414368823-427216-1-git-send-email-sandals@crustytoothpaste.net>

Asciidoctor provides an extension implementing a backend-independent macro for dealing with manpage links just like the linkgit macro. As this is more likely to be up-to-date with future changes in Asciidoctor, prefer using it over reimplementing in Git.

This reverts commit 773ee47c2b9c691d9758b2bea6cac10e3f0c4e12.
---
 Documentation/extensions.rb | 39 ---------------------------------------
 1 file changed, 39 deletions(-)
 delete mode 100644 Documentation/extensions.rb
diff --git a/Documentation/extensions.rb b/Documentation/extensions.rb
deleted file mode 100644
index c33a50d..0000000
--- a/Documentation/extensions.rb
+++ /dev/null
@@ -1,39 +0,0 @@
-require 'asciidoctor'
-require 'asciidoctor/extensions'
-
-module Git
-  module Documentation
-    class LinkGitProcessor < Asciidoctor::Extensions::InlineMacroProcessor
-      use_dsl
-
-      named :chrome
-
-      def process(parent, target, attrs)
-        if parent.document.basebackend? 'html'
-          generate_html(parent, target, attrs)
-        elsif parent.document.basebackend? 'docbook'
-          generate_docbook(parent, target, attrs)
-        end
-      end
-
-      private
-
-      def generate_html(parent, target, attrs)
-        section = attrs.has_key?(1) ? "(#{attrs[1]})" : ''
-        prefix = parent.document.attr('git-relative-html-prefix') || ''
-        %(<a href="#{prefix}#{target}.html">#{target}#{section}</a>\n)
-      end
-
-      def generate_docbook(parent, target, attrs)
-        %(<citerefentry>
-<refentrytitle>#{target}</refentrytitle><manvolnum>#{attrs[1]}</manvolnum>
-</citerefentry>
-)
-      end
-    end
-  end
-end
-
-Asciidoctor::Extensions.register do
-  inline_macro Git::Documentation::LinkGitProcessor, :linkgit
-end
-- 
2.1.1
Previous: brian m. carlsonNext: Jeff King
Message 3 of 4 in “Followup patches for Asciidoctor”
  1. 0/2 Followup patches for Asciidoctorbrian m. carlson, Oct 27, 2014
  2. 1/2 Documentation: refactor common operations into variablesbrian m. carlson, Oct 27, 2014
  3. 2/2 Documentation: remove Asciidoctor linkgit macrobrian m. carlson, Oct 27, 2014
  4. Jeff KingOct 27, 2014

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.