From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp1.migadu.com ([2001:41d0:403:58f0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms13.migadu.com with LMTPS id sFP2LSzcbmbMhAAA62LTzQ:P1 (envelope-from ) for ; Sun, 16 Jun 2024 12:35:56 +0000 Received: from aspmx1.migadu.com ([2001:41d0:403:58f0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp1.migadu.com with LMTPS id sFP2LSzcbmbMhAAA62LTzQ (envelope-from ) for ; Sun, 16 Jun 2024 14:35:56 +0200 X-Envelope-To: larch@yhetil.org Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=posteo.net header.s=2017 header.b=UR0p56FW; dmarc=pass (policy=none) header.from=posteo.net; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1718541356; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=zuzeSnVv11EW2ihyafEQyU4nR/las2A+uuBEYS7RtOQ=; b=Ys4SMl8FHG6GgnE5hT2qBRrjns5jJvCgtVnAxcJGtuzUE9AbGIOT7Wd0p/4y6QTsoI+S6g /4LnRKnPE8M1vh5r+73RqNNz2sjmwNCRrYx57kHCWMFXVrKVpDuyGEIBonOWiyFMsfWFkT Oc9ZvBm3WBozh+Wblumqtbj7IxlcCBqM4wOdIoKVODtNiv+2ChEwMipWXtRnZIDxAZeT/s atgQYPlKFMWaXJCUGfYhr2g2M/7ikZZ3xZU5rv6gVKIK0Kf6gJj/sAcmGdBhi1ymEm7Rt6 eCwUwSk/rKsgMAidSpeXloyR5jg2+GPH3WHPVZS2duIrpiS5C7SSlRv5bn+Ulg== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1718541356; a=rsa-sha256; cv=none; b=Y1DRu8GvLx3WbJ6dke9Qo9KRFO4eL6Gk57JiwWwS7mUqpn5eGKXJEYLDmv3SdNvPeCjnrt IIZ89F3Vqq1zeJ4WTQbCbmpVtWep+NLsPP7C8qZF+iiM4Pq3siVJfcLijHGGVnsevT6XaN NVeePYnYzuQoIVgUTgpp2ZCTyAy5+SFakX+msg1Xoxr1jf/V8/ycD4MnsXSRaq8TkVO8XW pJl1O0swKuk8g+ztbwWK1HRKAQZuOT4xu8H6Z3IyHFZ8wYv7kIvn30CZKyzc+siKA5mJNN FgQvGOaN11hYUAYTkVaPfdg4QZpy/ZnrsrG6JCV68AcKd5uK2FV2rVkJYV8zPw== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=posteo.net header.s=2017 header.b=UR0p56FW; dmarc=pass (policy=none) header.from=posteo.net; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" 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 90C1678A51 for ; Sun, 16 Jun 2024 14:35:56 +0200 (CEST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sIp6D-0006dX-6t; Sun, 16 Jun 2024 08:35:09 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sIp6B-0006dP-Ng for emacs-orgmode@gnu.org; Sun, 16 Jun 2024 08:35:07 -0400 Received: from mout02.posteo.de ([185.67.36.66]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sIp69-0000Cm-I1 for emacs-orgmode@gnu.org; Sun, 16 Jun 2024 08:35:07 -0400 Received: from submission (posteo.de [185.67.36.169]) by mout02.posteo.de (Postfix) with ESMTPS id 527A6240101 for ; Sun, 16 Jun 2024 14:35:01 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1718541302; bh=U5D5yzWny33sfUM+XOam5OcEOq3gRQo6wBK0JUSa4EQ=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version:Content-Type: From; b=UR0p56FWbKoZlv3twzhkfL3R0BseG5Gt3pTXHH2lOo1eJ4cMm139VrAof0bRaC921 CiKNVEQNUFxr9TyC7VVVow+myPSQLr3+DavmH/OyHdlsNmW0mK8DiPEireo2WTrHX3 9wlMp+U/lLpk3c52BBycULhhoxeuXUsHmReu7tNrADeSypNcpAPUtExoXVvOsjsPae gfE3AuCDY4ooG3v7xTO1exT6EcHN3cz/F/d4OlP7BtLuPXaECw4HTOxHRjUQpcAgVi NmhWJ/ASsD+WcQevhruYlxcjhtO3WqOtHztS8DCLsrF35c7k1MP3+D67Pceby6lLIz rFKQXZ6Bp4A6w== Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4W2CC84jbdz6tsB; Sun, 16 Jun 2024 14:35:00 +0200 (CEST) From: Ihor Radchenko To: Daniel Clemente Cc: Eli Zaretskii , emacs-orgmode@gnu.org Subject: Re: Please document the caching and its user options In-Reply-To: References: <86ed921oxu.fsf@gnu.org> <874j9vllbp.fsf@localhost> Date: Sun, 16 Jun 2024 12:36:45 +0000 Message-ID: <87o781t676.fsf@localhost> MIME-Version: 1.0 Content-Type: text/plain Received-SPF: pass client-ip=185.67.36.66; envelope-from=yantar92@posteo.net; helo=mout02.posteo.de X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.4 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=unavailable autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.29 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-bounces+larch=yhetil.org@gnu.org X-Migadu-Flow: FLOW_IN X-Migadu-Country: US X-Migadu-Spam-Score: -6.57 X-Spam-Score: -6.57 X-Migadu-Queue-Id: 90C1678A51 X-Migadu-Scanner: mx11.migadu.com X-TUID: udTDZRF/tkCt Daniel Clemente writes: > In particular, when setting (setq org-element-cache-persistent nil) > org-mode *should not* create an org-persist directory anywhere. And I > think it shouldn't activate org-persist timers (it does now) or hooks. > The user's preference should be respected. Nope. "org-persist" directory is not only used by org-element. If some other parts of Org need to cache something, they can also store cache there. > That's a code change. > If you just want to update documentation, a starting point can be > org-element-cache-persistent's documentation, which is just "Non-nil > when cache should persist between Emacs sessions.", and doesn't > mention that some files will always be created even if it's nil. It > also doesn't explicitly mention that it will create files (better be > explicit about this), or where (or how to control where), or which > content (i.e. just statistics, or parts of possible private org > files). May you suggest an alternative docstring? > I suggest making an explicit difference between "caching in memory" > and "caching by storing files on disk". > For instance: > (defvar org-element-use-cache t > "Non-nil when Org parser should cache its results.") > From that description, it's not clear to a new user whether they're > creating files on disk (as caches often do) or not. Do you mean something like "Non-nil when Org parser should cache its results. The cache is stored in-memory and may also be stored on disk if `org-element-cache-persistent' is non-nil (the default)." ? -- Ihor Radchenko // yantar92, Org mode contributor, Learn more about Org mode at . Support Org development at , or support my work at