* Syncing orgcard.tex with upstream Emacs (was: bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.)
[not found] ` <87wmttti1k.fsf@kyleam.com>
@ 2023-12-05 12:37 ` Ihor Radchenko
2023-12-06 1:44 ` Kyle Meyer
0 siblings, 1 reply; 6+ messages in thread
From: Ihor Radchenko @ 2023-12-05 12:37 UTC (permalink / raw)
To: Kyle Meyer; +Cc: Bastien Guerry, emacs-orgmode
Kyle Meyer <kyle@kyleam.com> writes:
> Here is the difference between the two cards, as of the last sync:
>
> -\input org-version.tex
> +\def\orgversionnumber{9.6.11}
> +\def\versionyear{2023} % latest update
> +\input emacsver.tex
> ...
> +\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}}
> +
Aside: It appears to be only partially documented in
https://orgmode.org/worg/org-maintenance.html#emacs-sync. In particular,
the last two lines.
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?
--
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>
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: Syncing orgcard.tex with upstream Emacs (was: bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.)
2023-12-05 12:37 ` Syncing orgcard.tex with upstream Emacs (was: bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.) Ihor Radchenko
@ 2023-12-06 1:44 ` Kyle Meyer
2023-12-06 14:13 ` Ihor Radchenko
0 siblings, 1 reply; 6+ messages in thread
From: Kyle Meyer @ 2023-12-06 1:44 UTC (permalink / raw)
To: Ihor Radchenko; +Cc: Bastien Guerry, emacs-orgmode
Ihor Radchenko writes:
> Kyle Meyer <kyle@kyleam.com> writes:
>
>> Here is the difference between the two cards, as of the last sync:
>>
>> -\input org-version.tex
>> +\def\orgversionnumber{9.6.11}
>> +\def\versionyear{2023} % latest update
>> +\input emacsver.tex
>> ...
>> +\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}}
>> +
>
> 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?
> 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.
[*] https://git.kyleam.com/orgmode-backport-notes/tree/orgmode-backports.org?id=35eaf5a21dc776c9f7a880d0a4bf9ffc48213985#n3464
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: Syncing orgcard.tex with upstream Emacs (was: bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.)
2023-12-06 1:44 ` Kyle Meyer
@ 2023-12-06 14:13 ` Ihor Radchenko
2023-12-07 4:53 ` Kyle Meyer
0 siblings, 1 reply; 6+ messages in thread
From: Ihor Radchenko @ 2023-12-06 14:13 UTC (permalink / raw)
To: Kyle Meyer; +Cc: Bastien Guerry, emacs-orgmode
[-- Attachment #1: Type: text/plain, Size: 2091 bytes --]
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?
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-etc-refcards-orgcard.tex-Put-Emacs-specific-part-int.patch --]
[-- Type: text/x-patch, Size: 1858 bytes --]
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: 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
[-- Attachment #3: Type: text/plain, Size: 224 bytes --]
--
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>
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: Syncing orgcard.tex with upstream Emacs (was: bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.)
2023-12-06 14:13 ` Ihor Radchenko
@ 2023-12-07 4:53 ` Kyle Meyer
2023-12-07 10:42 ` Ihor Radchenko
0 siblings, 1 reply; 6+ messages in thread
From: Kyle Meyer @ 2023-12-07 4:53 UTC (permalink / raw)
To: Ihor Radchenko; +Cc: Bastien Guerry, emacs-orgmode
Ihor Radchenko writes:
> I think that a reference to
> https://git.kyleam.com/orgmode-backport-notes/tree/orgmode-backports.org#n2
> might be helpful.
Okay, I'll make a note to add one.
> Maybe we should even have that file in the main repo as a part of
> emacs-sync branch?
I prefer not to. I intended that branch to track the state of Org files
that are synced, not to store auxiliary logs.
> I can see the point. Although, I feel like accumulating such divergence
> may backfire after some time.
How do you see this particular spot backfiring? If Emacs changes the
Emacs-specific text (as they did once in 2016), I port that to the
emacs-sync branch. Or if Org changes neighboring text, I resolve the
conflict on merge into emacs-sync (very likely just taking both sides).
The resolution is recorded for anyone to look back on.
The emacs-sync branch provides a transparent way to keep track of the
limited set of Emacs-specific modifications needed for the sync. We're
not talking about an ever-growing set of changes.
> 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.
I don't see what problem it solves. It's moving the divergence to a
different file (that would still be tracked in emacs-sync), and it adds
one more Org-specific wrinkle to the Emacs tree. (Also, the orgcard
source would still be different given the upstream hunk in the diff I
posted in my last message.)
> Are there other similar conflicts in emacs-sync branch?
The emacs-sync branch has other Emacs-specific modifications, yes.
Again, keeping track of those is the reason it exists.
$ git diff --stat bugfix...emacs-sync
.gitignore | 1 -
doc/{doc-setup.org => org-setup.org} | 2 +-
doc/{org-manual.org => org.org} | 4 ++--
doc/orgcard.tex | 7 ++++++-
etc/schema/schemas.xml | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
lisp/org-version.el | 24 ++++++++++++++++++++++++
6 files changed, 90 insertions(+), 5 deletions(-)
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: Syncing orgcard.tex with upstream Emacs (was: bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.)
2023-12-07 4:53 ` Kyle Meyer
@ 2023-12-07 10:42 ` Ihor Radchenko
2023-12-08 3:14 ` Kyle Meyer
0 siblings, 1 reply; 6+ messages in thread
From: Ihor Radchenko @ 2023-12-07 10:42 UTC (permalink / raw)
To: Kyle Meyer; +Cc: Bastien Guerry, emacs-orgmode
Kyle Meyer <kyle@kyleam.com> writes:
>> Maybe we should even have that file in the main repo as a part of
>> emacs-sync branch?
>
> I prefer not to. I intended that branch to track the state of Org files
> that are synced, not to store auxiliary logs.
> ...
> The emacs-sync branch provides a transparent way to keep track of the
> limited set of Emacs-specific modifications needed for the sync. We're
> not talking about an ever-growing set of changes.
> ...
> The emacs-sync branch has other Emacs-specific modifications, yes.
> Again, keeping track of those is the reason it exists.
>
> $ git diff --stat bugfix...emacs-sync
> .gitignore | 1 -
> doc/{doc-setup.org => org-setup.org} | 2 +-
> doc/{org-manual.org => org.org} | 4 ++--
> doc/orgcard.tex | 7 ++++++-
> etc/schema/schemas.xml | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
> lisp/org-version.el | 24 ++++++++++++++++++++++++
> 6 files changed, 90 insertions(+), 5 deletions(-)
I see now. I guess I did not really have a full understanding of the
purpose of emacs-sync. So, it might be helpful to add a similar
explanation to worg/org-maintenance.org.
>> I can see the point. Although, I feel like accumulating such divergence
>> may backfire after some time.
>
> How do you see this particular spot backfiring? If Emacs changes the
> Emacs-specific text (as they did once in 2016), I port that to the
> emacs-sync branch. Or if Org changes neighboring text, I resolve the
> conflict on merge into emacs-sync (very likely just taking both sides).
> The resolution is recorded for anyone to look back on.
I was mainly concerned about complex conflicts that might
(theoretically) occur. But it indeed does not matter if the conflicts
are limited and manageable.
>> 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.
>
> I don't see what problem it solves. It's moving the divergence to a
> different file (that would still be tracked in emacs-sync), and it adds
> one more Org-specific wrinkle to the Emacs tree. (Also, the orgcard
> source would still be different given the upstream hunk in the diff I
> posted in my last message.)
My idea was not to sync that another extra file at all and leave it in
Emacs repo only. But the same will not work for xml and other diverging
files. I now don't see any reason to change the existing state of affairs.
--
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>
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: Syncing orgcard.tex with upstream Emacs (was: bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.)
2023-12-07 10:42 ` Ihor Radchenko
@ 2023-12-08 3:14 ` Kyle Meyer
0 siblings, 0 replies; 6+ messages in thread
From: Kyle Meyer @ 2023-12-08 3:14 UTC (permalink / raw)
To: Ihor Radchenko; +Cc: Bastien Guerry, emacs-orgmode
Ihor Radchenko writes:
> I see now. I guess I did not really have a full understanding of the
> purpose of emacs-sync. So, it might be helpful to add a similar
> explanation to worg/org-maintenance.org.
Okay, I'll plan to do that.
>> I don't see what problem it solves. It's moving the divergence to a
>> different file (that would still be tracked in emacs-sync), and it adds
>> one more Org-specific wrinkle to the Emacs tree. (Also, the orgcard
>> source would still be different given the upstream hunk in the diff I
>> posted in my last message.)
>
> My idea was not to sync that another extra file at all and leave it in
> Emacs repo only.
I see. Not that it matters given what you say below, but I would
probably lean toward keeping track of such a file in emacs-sync.
> But the same will not work for xml and other diverging
> files. I now don't see any reason to change the existing state of affairs.
All right, thanks for your input. I'll try to improve
worg/org-maintenance.org as discussed.
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2023-12-08 3:15 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
[not found] <CAGQFwfgr-=jqC_SKLnsHxXgABhoZRTGL_ZYwuu0EgJ7YAG0wPw@mail.gmail.com>
[not found] ` <874jm8ythh.fsf@localhost>
[not found] ` <875y4bbz13.fsf@localhost>
[not found] ` <87r0kr9xke.fsf@localhost>
[not found] ` <871qcl33o2.fsf@gnu.org>
[not found] ` <CAGQFwfhFV97eAwWYN_P6EoVEHeS+sH2oOM0_0Qwac8zzspSnjg@mail.gmail.com>
[not found] ` <87ttoym8qu.fsf@localhost>
[not found] ` <CAGQFwfii4m8_i9Y-4GdUNMggzmYuc2uMu9aT7Zmg8x5oUi6-uQ@mail.gmail.com>
[not found] ` <CAGQFwfifY_rNYLBwNz0prQVE2YHiekciAVp6JHTtHi0ZwoGKEw@mail.gmail.com>
[not found] ` <87wmttti1k.fsf@kyleam.com>
2023-12-05 12:37 ` Syncing orgcard.tex with upstream Emacs (was: bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.) Ihor Radchenko
2023-12-06 1:44 ` Kyle Meyer
2023-12-06 14:13 ` Ihor Radchenko
2023-12-07 4:53 ` Kyle Meyer
2023-12-07 10:42 ` Ihor Radchenko
2023-12-08 3:14 ` Kyle Meyer
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).