Re: Syncing orgcard.tex with upstream Emacs (was: bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.)

[Ihor Radchenko]

Kyle Meyer <kyle@kyleam.com> writes:

>> Aside: It appears to be only partially documented in
>> https://orgmode.org/worg/org-maintenance.html#emacs-sync. In particular,
>> the last two lines.
>
> I'm happy to clarify or add to those docs.  I didn't write them, but I
> did go through them somewhat recently to better align them with the
> actual porting/syncing process.
>
> With respect to the emacs-sync branch, that page currently says
>
>   Typically, Org can be synchronized by copying over files from the
>   emacs-sync branch of the Org repository to the master branch of Emacs
>   repository. The emacs-sync branch has a few extra changes compared
>   with the bugfix branch
>
> Would you like me to add more details about why the branch exists?  How
> it's managed?  Something else?

I think that a reference to
https://git.kyleam.com/orgmode-backport-notes/tree/orgmode-backports.org#n2
might be helpful. Maybe we should even have that file in the main repo
as a part of emacs-sync branch?

>> May we just add
>>
>>>   +\centerline{For more Emacs documentation, and the \TeX{} source for this 
>>> card, see}
>>>   +\centerline{the Emacs distribution, or {\tt 
>>> https://www.gnu.org/software/emacs}}
>>
>> to Org repo?
>
> These lines (or rather what became these lines) were added in Emacs's
> 4af5981dc75 (Add a comment in generated refcards about the source,
> 2016-11-17).  I decided to port that commit to emacs-sync rather than a
> primary Org branch because I felt it only applied to the Org card
> distributed as part of the Emacs tree.  From my notes [*]:
>
>   I'm skipping this because it isn't true when the card is from the Org
>   mode repo.
>
> However, if you prefer to include those lines in Org's copy, that's fine
> by me.

I can see the point. Although, I feel like accumulating such divergence
may backfire after some time. May we possibly resolve the conflict
properly using something like the attached patch?
Then, we can use the same orgcard source but have orgcardemacsnotice.tex
empty in Org repository.

Are there other similar conflicts in emacs-sync branch?

>From 23a6b95b4755a7a2251e89db6ed91ac8637a8035 Mon Sep 17 00:00:00 2001
Message-ID: 
<23a6b95b4755a7a2251e89db6ed91ac8637a8035.1701871917.git.yantar92@posteo.net>
From: Ihor Radchenko <yantar92@posteo.net>
Date: Wed, 6 Dec 2023 15:09:59 +0100
Subject: [PATCH] etc/refcards/orgcard.tex: Put Emacs-specific part into a
 separate file

* etc/refcards/orgcardemacsnotice.tex: New file containing
Emacs-specific copyright notice.  This is to be kept in Emacs
repository.
* etc/refcards/orgcard.tex: Include the new file, so that we do not
need to maintain divergence between Org repository version of orgcard
and the Emacs version.  The Org version does not refer to Emacs
distribution and the original source.

Link: 87ttowt89m.fsf@kyleam.com">https://orgmode.org/list/87ttowt89m.fsf@kyleam.com
---
 etc/refcards/orgcard.tex            | 3 +--
 etc/refcards/orgcardemacsnotice.tex | 2 ++
 2 files changed, 3 insertions(+), 2 deletions(-)
 create mode 100644 etc/refcards/orgcardemacsnotice.tex

diff --git a/etc/refcards/orgcard.tex b/etc/refcards/orgcard.tex
index 4b73a544e80..9d875e0f201 100644
--- a/etc/refcards/orgcard.tex
+++ b/etc/refcards/orgcard.tex
@@ -79,8 +79,7 @@
 \centerline{Released under the terms of the GNU General Public License}
 \centerline{version 3 or later.}
 
-\centerline{For more Emacs documentation, and the \TeX{} source for this card, 
see}
-\centerline{the Emacs distribution, or {\tt 
https://www.gnu.org/software/emacs}}
+\input orgcardemacsnotice.tex
 
 \endgroup}
 
diff --git a/etc/refcards/orgcardemacsnotice.tex 
b/etc/refcards/orgcardemacsnotice.tex
new file mode 100644
index 00000000000..ce7117c2330
--- /dev/null
+++ b/etc/refcards/orgcardemacsnotice.tex
@@ -0,0 +1,2 @@
+\centerline{For more Emacs documentation, and the \TeX{} source for this card, 
see}
+\centerline{the Emacs distribution, or {\tt 
https://www.gnu.org/software/emacs}}
-- 
2.42.0

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>