[PATCH] org-manual: Use ol-man.el in "Adding Hyperlink Types"

[PATCH] org-manual: Use ol-man.el in "Adding Hyperlink Types"

[Tom Gillespie]

[-- Attachment #1: Type: text/plain, Size: 199 bytes --]

Hi,
This is a tiny change to the manual to account for the change from org
-> ol in the org-man example. There may be other references in the
manual that have similar issues but I did not check.
Tom

[-- Attachment #2: 0001-org-manual-Use-ol-man.el-in-Adding-Hyperlink-Types.patch --]
[-- Type: text/x-patch, Size: 1994 bytes --]

From b2b8088f958379552f5c9dc228dcda56b7e6f738 Mon Sep 17 00:00:00 2001
From: Tom Gillespie <tgbugs@gmail.com>
Date: Wed, 8 Jan 2020 16:13:49 -0800
Subject: org-manual: Use ol-man.el in "Adding Hyperlink Types"

doc/org-manual.org (Adding Hyperlink Types): Update the name of the
example file from org-man.el to ol-man.el to reflect the renaming of
files related to org links.

I found this thorougly confusing when trying to (require 'org-man)
since it was clearly referenced as being in contrib, hopefully this
change will prevent anyone else from encountering the same confusion.

TINYCHANGE
---
 doc/org-manual.org | 17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 deletions(-)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index 22c2a9fb6..f9437976c 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -19695,10 +19695,11 @@ process of adding Org links to Unix man pages, which look like this
 : [[man:printf][The printf manual]]
 
 #+texinfo: @noindent
-The following =org-man.el= file implements it
+The following =ol-man.el= file implements it
 
 #+begin_src emacs-lisp
-;;; org-man.el - Support for links to man pages in Org mode
+;;; ol-man.el - Support for links to man pages in Org mode
+(require 'ol)
 (require 'org)
 
 (org-link-set-parameters "man"
@@ -19741,8 +19742,8 @@ The following =org-man.el= file implements it
       (`ascii (format "%s (%s)" desc path))
       (t path))))
 
-(provide 'org-man)
-;;; org-man.el ends here
+(provide ol-man)
+;;; ol-man.el ends here
 #+end_src
 
 #+texinfo: @noindent
@@ -19750,13 +19751,15 @@ To activate links to man pages in Org, enter this in the Emacs init
 file:
 
 #+begin_src emacs-lisp
-(require 'org-man)
+(require 'ol-man)
 #+end_src
 
 #+texinfo: @noindent
-A review of =org-man.el=:
+A review of =ol-man.el=:
+
+1. First, =(require 'ol)= ensures that =ol.el= is loaded and
+   =(require 'org)= ensures =org.el= is loaded.
 
-1. First, =(require 'org)= ensures =org.el= is loaded.
 
 2.
 
-- 
2.24.1

Re: [PATCH] org-manual: Use ol-man.el in "Adding Hyperlink Types"

[Nicolas Goaziou]

Hello,

Tom Gillespie <tgbugs@gmail.com> writes:

> This is a tiny change to the manual to account for the change from org
> -> ol in the org-man example. There may be other references in the
> manual that have similar issues but I did not check.

Applied. Thank you.

> TINYCHANGE

I removed this since you have signed FSF papers.

Regards,

-- 
Nicolas Goaziou

Re: [PATCH] org-manual: Use ol-man.el in "Adding Hyperlink Types"

[Tom Gillespie]

Great thanks!

On Thu, Jan 9, 2020 at 8:50 AM Nicolas Goaziou <mail@nicolasgoaziou.fr> wrote:
> I removed this since you have signed FSF papers.

Got it, I'll leave it out in the future and add a note in
org-contribute.org in case someone
else missed the implication of that paragraph.