From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2 ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id u8vJHLCaVGHg/wAAgWs5BA (envelope-from ) for ; Wed, 29 Sep 2021 18:56:16 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2 with LMTPS id QJ3YF7CaVGFwXAAAB5/wlQ (envelope-from ) for ; Wed, 29 Sep 2021 16:56:16 +0000 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 5A4042F917 for ; Wed, 29 Sep 2021 18:56:15 +0200 (CEST) Received: from localhost ([::1]:52038 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mVcsQ-0007P1-3h for larch@yhetil.org; Wed, 29 Sep 2021 12:56:14 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:39948) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mVcrr-0007Mj-CW for emacs-orgmode@gnu.org; Wed, 29 Sep 2021 12:55:39 -0400 Received: from ciao.gmane.io ([116.202.254.214]:53782) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mVcro-0008EH-Se for emacs-orgmode@gnu.org; Wed, 29 Sep 2021 12:55:38 -0400 Received: from list by ciao.gmane.io with local (Exim 4.92) (envelope-from ) id 1mVcrk-0002El-KR for emacs-orgmode@gnu.org; Wed, 29 Sep 2021 18:55:32 +0200 X-Injected-Via-Gmane: http://gmane.org/ To: emacs-orgmode@gnu.org From: Max Nikulin Subject: [PATCH] org-manual.org: Some correction of Installation section Date: Wed, 29 Sep 2021 23:55:23 +0700 Message-ID: Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="------------EFA489A7E8A795DB21ECEFB6" User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.13.0 X-Mozilla-News-Host: news://news.gmane.io:119 Content-Language: en-US Received-SPF: pass client-ip=116.202.254.214; envelope-from=geo-emacs-orgmode@m.gmane-mx.org; helo=ciao.gmane.io X-Spam_score_int: 28 X-Spam_score: 2.8 X-Spam_bar: ++ X-Spam_report: (2.8 / 5.0 requ) BAYES_00=-1.9, DKIM_ADSP_CUSTOM_MED=0.001, FORGED_GMAIL_RCVD=1, FORGED_MUA_MOZILLA=2.309, FREEMAIL_FORGED_FROMDOMAIN=0.249, FREEMAIL_FROM=0.001, HEADER_FROM_DIFFERENT_DOMAINS=0.249, NML_ADSP_CUSTOM_MED=0.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: "Emacs-orgmode" X-Migadu-Flow: FLOW_IN ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1632934575; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type:list-id:list-help:list-unsubscribe: list-subscribe:list-post; bh=p4muEmtQWfRkFs219c1gG3Dj+vG48NDDevJ2j7rsiA8=; b=rFCPylDxbQKUyuln1MsQI2mVQK4/bfa/YBzokxMSPfBMWUFugKGvtVOs9zTHFqRwKTwzQW 50FqBSGvg42IdsEknHeJkQ3pXyNP8gbxiDhhjQFbSeD5WXUs8b/YgdrvngoF+DS9+gMzKv cmb28OsJv+k+dO3aV9FEFnx9cGF9r/lMFA6Yn6qMhSrekgXG+lZLJdh87KpIi4xJF+2o3J yp3SxYPb0cLHf0h3YknrPC+ba8qKPIjmWZPFiD9pBuKA3sC5r3dKHQt68cv5nSSrDlPlcw h8j/qtxSwZzNtgQ+zuIrLg7tGBRN1DeIh5VDLjOoeEjEtIRB/tch4OKJsnG1oA== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1632934575; a=rsa-sha256; cv=none; b=U8xl3+oWG/leiaPffbMDJ4wjZwTJKbhnd+YnPB5htHevokskGdk2qmAoDjteMoS0iLkOqL atM+gaFhLc++qT5YpFebaAah6vRNL4GbXoO/S1FBTcY5CpThnST0gVA8+0I4gGncOrbRsr fJDapBUtPXSXreuwKBSJ7W1oaiMMVT1iPlOrzj4lpaxKfzsEm0Ac7Evb9DR8ENGQwBaUMT LsFnYU4X4tX+X6oJgyA6WhE133uiSKJ4+FLvxdJL4MCUAzgwi8kegY/XPaQLLJYaZBmOc0 D+Ev4di8KFfg84vWu/BmEM3lmuyHq48SSSxvovcDbEvRSbXzosgqzO3mMQOV5g== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=none; dmarc=fail reason="SPF not aligned (relaxed), No valid DKIM" header.from=gmail.com (policy=none); spf=pass (aspmx1.migadu.com: domain of emacs-orgmode-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=emacs-orgmode-bounces@gnu.org X-Migadu-Spam-Score: -1.80 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=fail reason="SPF not aligned (relaxed), No valid DKIM" header.from=gmail.com (policy=none); spf=pass (aspmx1.migadu.com: domain of emacs-orgmode-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=emacs-orgmode-bounces@gnu.org X-Migadu-Queue-Id: 5A4042F917 X-Spam-Score: -1.80 X-Migadu-Scanner: scn0.migadu.com X-TUID: 56whQNvA2YFV This is a multi-part message in MIME format. --------------EFA489A7E8A795DB21ECEFB6 Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit 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. --------------EFA489A7E8A795DB21ECEFB6 Content-Type: text/x-patch; charset=UTF-8; name="0001-org-manual.el-Restore-load-path-for-git-version.patch" Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename*0="0001-org-manual.el-Restore-load-path-for-git-version.patch" >From b9ae3b156ac46b4ea76103ea9ae8e20b0014784d Mon Sep 17 00:00:00 2001 From: Max Nikulin 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 --------------EFA489A7E8A795DB21ECEFB6 Content-Type: text/x-patch; charset=UTF-8; name="0002-org-manual.org-Mention-org-contrib-NonGNU-ELPA-packa.patch" Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename*0="0002-org-manual.org-Mention-org-contrib-NonGNU-ELPA-packa.pa"; filename*1="tch" >From 743d9a76aae164fb8bc8dd16f1cfdea27223c012 Mon Sep 17 00:00:00 2001 From: Max Nikulin 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 --------------EFA489A7E8A795DB21ECEFB6 Content-Type: text/x-patch; charset=UTF-8; name="0003-org-manual.org-Another-way-to-run-version-from-git.patch" Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename*0="0003-org-manual.org-Another-way-to-run-version-from-git.patc"; filename*1="h" >From 6358a830c4356fcbcac1d18959f5dc45f78993d1 Mon Sep 17 00:00:00 2001 From: Max Nikulin 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 --------------EFA489A7E8A795DB21ECEFB6--