From: Ihor Radchenko <yantar92@posteo.net>
To: Morgan Smith <Morgan.J.Smith@outlook.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: [PATCH] Rewrite `org-clock-sum'
Date: Tue, 30 Apr 2024 10:59:03 +0000 [thread overview]
Message-ID: <87y18vxgjs.fsf@localhost> (raw)
In-Reply-To: <CH3PR84MB3424DC5A13943A4A500FEE3CC5152@CH3PR84MB3424.NAMPRD84.PROD.OUTLOOK.COM>
Morgan Smith <Morgan.J.Smith@outlook.com> writes:
> I may have rewritten org-clock-sum yet again. See attached patch.
>
> * things I want you to tell me
> 1. Does this look like something that could be eventually merged upstream or am
> I wasting my time?
Yes, it could be merged upstream. I do not see why not.
> 2. Would you like me to do more performance testing? I basically only tested
> my use case. If yes, should I create some test files for benchmarking that
> can be shared?
Your patch clearly provides more caching ability, so I anticipate an
improvement. I will still need to test is on my side though to be sure.
Having benchmarks would be nice, but optional.
> 3. Do you want `org-element-cache-map' fixed before we merge this patch? If
> yes, please be willing to wait. I have already spent probably about 8 hours
> looking into it and it still makes my head hurt.
A fix would be nice, but it should not be a blocker for your patch.
If necessary, we can discuss that function by screen sharing.
> * todo
> The patch is like 95% done. I still gotta
>
> 1. Write a decent docstring for `org-clock-ranges'. Maybe add a news entry for
> it too.
Or make it internal. Then, no news entry will be required.
I am not 100% sure if the return value is useful for generic use outside
org-clock-sum.
> 2. Check `org-clock-hd-marker' for open clock.
You can simply compare it with org-element-begin for current headline.
> 3. Figure out what to do about open clocks that aren't the current
> one. Historically we ignored them so I guess I should just do that.
Yes. Ideally, also document this in the docstring.
> 4. Maybe test clocking in inlinetasks. I honestly don't even know what these
> are.
********************************** TODO inline
********************************** END
They can appear in parallel with paragraphs.
Inlinetasks are an optional markup feature that is enabled by (require 'org-inlinetask)
> * Downsides of my rewrite
>
> 1. Does it still perform better with the cache disabled? idk. Probably not.
That should not be a problem. We are slowly moving Org code to use cache
API everywhere.
> 2. Radical change. Likely has bugs
Then, it would be nice to add some test coverage.
> 3. Dances around bugs in `org-element-cache-map' but does it actually dance
> around all of them?
It would be nice if you help with this by fixing known bugs and writing
more tests, but it is generally not a concern _you_ need to worry about
- I will (sooner or later) fix bugs in `org-element-cache-map' if they arise.
--
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-04-30 10:58 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-27 13:13 [PATCH] Rewrite `org-clock-sum' Morgan Smith
2024-04-30 10:59 ` 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=87y18vxgjs.fsf@localhost \
--to=yantar92@posteo.net \
--cc=Morgan.J.Smith@outlook.com \
--cc=emacs-orgmode@gnu.org \
/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).