[PATCH] org-manual.org: Some correction of Installation section

[PATCH] org-manual.org: Some correction of Installation section

[Max Nikulin]

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

Hi,

I have read another time "Installation" section of the Org Manual from 
main branch.  I am glad to see that contrib directory is replaced by the 
dedicated repository.  I decided to check it after looking at the 
version on the web site.  Some points might be improved though.

- I have noticed that a code snipped, assumed to be 'above', was removed 
earlier, so I restored it.
- Since Org as ELPA package is mentioned in this section, I suppose, 
org-contrib *package* deserves a similar link as well.
- I am in doubts whether "emacs -Q -L ~/src/org-mode/lisp" way to try 
version from git is important enough for the manual.  I have added a 
separate patch however to discuss such change.

If you think that some patches improve the manual, feel free to apply 
ones that you like or to suggest better variants.

[-- Attachment #2: 0001-org-manual.el-Restore-load-path-for-git-version.patch --]
[-- Type: text/x-patch, Size: 1193 bytes --]

From b9ae3b156ac46b4ea76103ea9ae8e20b0014784d Mon Sep 17 00:00:00 2001
From: Max Nikulin <manikulin@gmail.com>
Date: Wed, 29 Sep 2021 23:22:51 +0700
Subject: [PATCH 1/3] org-manual.el: Restore `load-path' for git version

* doc/org-manual.org (Using Org's git repository): Add example of
`load-path' adjustment that was earlier in the previous section
and was removed by commit f9cdda8234, so 'above' became a dangling
reference.
---
 doc/org-manual.org | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index 4366315a8..d96f9fbe6 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -121,8 +121,11 @@ Note that in this case, =make autoloads= is mandatory: it defines
 Org's version in =org-version.el= and Org's autoloads in
 =org-loaddefs.el=.
 
-Remember to add the correct load path as described in the method
-above.
+Make sure you set the load path correctly in your Emacs init file:
+
+#+begin_src emacs-lisp
+(add-to-list 'load-path "~/src/org-mode/lisp")
+#+end_src
 
 You can also compile with =make=, generate the documentation with
 =make doc=, create a local configuration with =make config= and
-- 
2.25.1


[-- Attachment #3: 0002-org-manual.org-Mention-org-contrib-NonGNU-ELPA-packa.patch --]
[-- Type: text/x-patch, Size: 1540 bytes --]

From 743d9a76aae164fb8bc8dd16f1cfdea27223c012 Mon Sep 17 00:00:00 2001
From: Max Nikulin <manikulin@gmail.com>
Date: Wed, 29 Sep 2021 23:27:54 +0700
Subject: [PATCH 2/3] org-manual.org: Mention org-contrib NonGNU ELPA package

* doc/org-manual.org (Installing Org's contributed packages): Add a link
to the NonGNU ELPA package as an option to install org-contrib.  Mention
the list of external packages on Worg.
---
 doc/org-manual.org | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index d96f9fbe6..b25da7889 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -141,9 +141,13 @@ Org Build System page on [[https://orgmode.org/worg/dev/org-build-system.html][W
 :END:
 
 Org's repository used to contain =contrib/= directory for add-ons
-contributed by others.  As of Org 9.5, the directory has bee moved to
-this new dedicated [[https://git.sr.ht/~bzg/org-contrib][org-contrib]] repository, which you can install
-separately.
+contributed by others.  As of Org 9.5, the directory has been moved to
+the dedicated org-contrib [[https://git.sr.ht/~bzg/org-contrib][repository]], which you can install
+separately as a [[https://elpa.nongnu.org/nongnu/org-contrib.html][package]] from NonGNU ELPA.
+
+There are enough valuable packages maintained outside of the Org repository.
+Worg has a list of [[https://orgmode.org/worg/org-contrib/index.html][org-contrib and external packages]], certainly it is not
+exhaustive.
 
 ** Activation
 :PROPERTIES:
-- 
2.25.1


[-- Attachment #4: 0003-org-manual.org-Another-way-to-run-version-from-git.patch --]
[-- Type: text/x-patch, Size: 1218 bytes --]

From 6358a830c4356fcbcac1d18959f5dc45f78993d1 Mon Sep 17 00:00:00 2001
From: Max Nikulin <manikulin@gmail.com>
Date: Wed, 29 Sep 2021 23:37:57 +0700
Subject: [PATCH 3/3] org-manual.org: Another way to run version from git

* doc/org-manual.org (Using Org's git repository): Suggest '-L' command
line option to test git version without modification of init file.
---
 doc/org-manual.org | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index b25da7889..af35149ec 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -127,6 +127,12 @@ Make sure you set the load path correctly in your Emacs init file:
 (add-to-list 'load-path "~/src/org-mode/lisp")
 #+end_src
 
+Alternatively, if you intention is to test the latest version and you are
+not going to use it permanently then suppress regular initialization,
+optionally provide minimal init file and specify load path in command line:
+
+: $ emacs -Q -L ~/src/org-mode/lisp -l /path/to/init-git.el
+
 You can also compile with =make=, generate the documentation with
 =make doc=, create a local configuration with =make config= and
 install Org with =make install=.  Please run =make help= to get the
-- 
2.25.1

Re: [PATCH] org-manual.org: Some correction of Installation section

[Ihor Radchenko]

Max Nikulin <manikulin@gmail.com> writes:

> - I am in doubts whether "emacs -Q -L ~/src/org-mode/lisp" way to try 
> version from git is important enough for the manual.  I have added a 
> separate patch however to discuss such change.

I feel that it should not be in the manual. However, it may be helpful
addition to https://orgmode.org/contribute.html

Also, I'd recommend "emacs -Q -L ~/src/org-mode/list -l org", making
sure that the right version of Org mode is loaded regardless of the
local config.

Best,
Ihor

Re: [PATCH] org-manual.org: Some correction of Installation section

[Bastien]

Hi Max,

Max Nikulin <manikulin@gmail.com> writes:

> If you think that some patches improve the manual, feel free to apply
> ones that you like or to suggest better variants.

Applied, thanks a lot!

-- 
 Bastien

Re: [PATCH] org-manual.org: Some correction of Installation section

[Bastien]

Ihor Radchenko <yantar92@gmail.com> writes:

> Max Nikulin <manikulin@gmail.com> writes:
>
>> - I am in doubts whether "emacs -Q -L ~/src/org-mode/lisp" way to try 
>> version from git is important enough for the manual.  I have added a 
>> separate patch however to discuss such change.
>
> I feel that it should not be in the manual. However, it may be helpful
> addition to https://orgmode.org/contribute.html

Yes, I reverted this commit.

-- 
 Bastien