From: Ihor Radchenko <yantar92@posteo.net>
To: Rudi C <rudiwillalwaysloveyou@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: Principled Handling of Breaking Changes
Date: Sat, 16 Mar 2024 11:33:56 +0000 [thread overview]
Message-ID: <87h6h6if6j.fsf@localhost> (raw)
In-Reply-To: <CAE9z9A2sKoRSfGrxT0K-zOSs6Qez8GTB3xh-nZXGBE8WsEWiqQ@mail.gmail.com>
Rudi C <rudiwillalwaysloveyou@gmail.com> writes:
>> what other breaking changes caused problems for you?
>
> I remember these three:
>
> - `tab-width`
> - fontification in example blocks (
> https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=9daad41cc)
> - `org-fold-core-style` changing to `text-properties` (from `overlays`)
> broke custom code I had for coloring links.
I think I need to clarify a bit about how we consider changes in Org mode.
- We rarely touch default values in user customization - same as what
Emacs does. Every time we do go ahead with changing customization
defaults, we consider such a change very carefully.
Changing tab-width has a strong justification - we are aiming to
stabilize Org mode markup and register it officially. So, all aspects
of Org markup will eventually be decoupled from Emacs customization.
(the other question is whether we can avoid co-lateral damage; let's
discuss it in the other thread)
- We reserve the right to change internal implementation details of Org
mode at will. Like the details how folding is implemented. Any other
policy would make it impossible to add new and improve existing
features of Org mode. Emacs has the same policy.
Yet, we take care to communicate major changes in the internals to
users who might be relying upon implementation details.
- We also reserve the right to alter undocumented features of Org mode.
We do not exercise this right at will though - if we can keep some
undocumented feature without too much effort, we do.
Example block fontification was one of the undocumented features. As
per the commit you linked to, we restored example block fontification
and added a comment in the code to avoid future accidental breakage
upon reporting.
>> The very first section in https://orgmode.org/Changes.html lists
>> breaking and important changes.
>
> I don't care about "important changes" though, I just want the breaking
> changes ... I guess I should allocate the needed time for reading this
> anyway.
The exact name of the section is "Important announcements and breaking
changes". By "important announcements", we really mean important -
something that may need action. For example, changes in folding
machinery where not breaking (they did not break any documented
feature), but certainly important enough to bring to everyone's
attention.
--
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>
prev parent reply other threads:[~2024-03-16 11:35 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-16 5:39 Principled Handling of Breaking Changes Rudi C
2024-03-16 10:18 ` Ihor Radchenko
2024-03-16 10:38 ` Rudi C
2024-03-16 11:33 ` Ihor Radchenko [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87h6h6if6j.fsf@localhost \
--to=yantar92@posteo.net \
--cc=emacs-orgmode@gnu.org \
--cc=rudiwillalwaysloveyou@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).