From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Karl Fogel Newsgroups: gmane.emacs.devel Subject: Re: Improving documentation of Org Mode integration into Emacs. Date: Mon, 10 Jan 2022 10:20:27 -0600 Message-ID: <87ilurftpw.fsf@red-bean.com> References: <87zgpgax7w.fsf@red-bean.com> <834k7n5zfu.fsf@gnu.org> <87fsq5tnni.fsf@red-bean.com> <87ee5mlvyc.fsf@red-bean.com> <83lezu9tv1.fsf@gnu.org> <87zgo4v8rb.fsf@red-bean.com> <87czl0j7vf.fsf@gmx.de> <87bl0kgdto.fsf@red-bean.com> <87zgo4hrjq.fsf@gmx.de> Reply-To: Karl Fogel Mime-Version: 1.0 Content-Type: text/plain; format=flowed Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="778"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux) Cc: Kyle Meyer , emacs-devel@gnu.org To: Michael Albinus Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Mon Jan 10 17:22:29 2022 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1n6xRF-000AYz-3o for ged-emacs-devel@m.gmane-mx.org; Mon, 10 Jan 2022 17:22:29 +0100 Original-Received: from localhost ([::1]:39608 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1n6xRE-0004cm-4z for ged-emacs-devel@m.gmane-mx.org; Mon, 10 Jan 2022 11:22:28 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:54820) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1n6xPM-0002y8-Cj for emacs-devel@gnu.org; Mon, 10 Jan 2022 11:20:33 -0500 Original-Received: from sanpietro.red-bean.com ([45.79.25.59]:47138) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1n6xPK-000859-BQ for emacs-devel@gnu.org; Mon, 10 Jan 2022 11:20:31 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=red-bean.com; s=202005newsp; h=Content-Type:MIME-Version:Message-ID: In-Reply-To:Date:Reply-To:References:Subject:Cc:To:From:Sender: Content-Transfer-Encoding:Content-ID:Content-Description; bh=hsbSJV6FygVjBlmrfjp9tCmOrgkIWa0j9le8PxcFB+c=; t=1641831629; x=1643041229; b=dUXTh92up7y8prhsUtNR+Ls8r3IrwnhNz3OjbFcaLaWrFvXrEEQeYT/0JuxYwxxtDVqoKMDMlfN 7O1Tqan/MmKa3B6n15vTkPSyWkJAukUMpWxi0ORWqhA3SWGrGeTmxRk9k0T09IeSwOaugADMasQog kIr3dalEwVLi0+6B4+WdiET7XaktKRXhzAX0+unrXJV0aWPY7qF2G6uTewoOALLQ+wJZoYQVMQ0KY Bd9gPgStF7Ab8U4iDjA62cjwHBDJ8X/jF3JOlphegmMmvGQtMlm+hH4BXHchl3s/zRw7DJgI0nB8g qb5EK7i1hRKqm9gg71+A7+wv5JwBMmHLbhmQ==; Original-Received: from 99-112-125-163.lightspeed.cicril.sbcglobal.net ([99.112.125.163]:60530 helo=floss) by sanpietro.red-bean.com with esmtpsa (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.94.2) (envelope-from ) id 1n6xPH-001UYY-SO; Mon, 10 Jan 2022 16:20:28 +0000 In-Reply-To: <87zgo4hrjq.fsf@gmx.de> (Michael Albinus's message of "Mon, 10 Jan 2022 10:24:25 +0100") Received-SPF: pass client-ip=45.79.25.59; envelope-from=kfogel@red-bean.com; helo=sanpietro.red-bean.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 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, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:284539 Archived-At: On 10 Jan 2022, Michael Albinus wrote: >>> I'm not sure that this is always the case. For Tramp, I'm >>> happy if >>> people refer to the Emacs repo files; sync with the upstream >>> package >>> is something contributors don't need to worry about. We shall >>> keep >>> the barrier low. >> >> Hmmm. In that case, should Tramp be listed in the "Externally >> maintained packages" section of admin/MAINTAINERS at all? > >It is OK to be listed there. I just don't want to *urge* people >to use >the Tramp repo, unless it is needed. Hmm, but how will they know whether it is needed? Perhaps the new "Notes" field in the Tramp entry could give some guidance on that. The original goal of this change was to provide guidance to contributors who might otherwise waste time doing the wrong thing. For example, they might fail to check upstream to see if a bug has already been fixed there, or is being discussed there; or they might send a contribution to Emacs when really it should be sent somewhere else; etc. So if there are circumstances in which contributors should worry about these possibilities for Tramp, then the Tramp entry in that file should explain what those circumstances are -- this is, after all, what the entry is for :-). >And the information about Tramp's bug tracker and backward >compatibility (just pushed to the repo) makes it worthwile. Got it. So it sounds like the "Notes" field should give some advice about checking the upstream sources and bug tracker first, when trying to find out if a bug is already known/addressed. And if you're happy to accept patches against the sources shipped in Emacs, even when those sources are slightly out-of-date with respect to what you have upstream, then "Notes" can say that too. Thoughts? Best regards, -Karl