From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Jean Louis Newsgroups: gmane.emacs.help Subject: Re: Elisp headers (was: Re: subheadings for elisp files) Date: Mon, 24 May 2021 00:38:45 +0300 Message-ID: References: <87wnrpxian.fsf_-_@zoho.eu> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="39653"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Mutt/2.0.6 (2021-03-06) To: help-gnu-emacs@gnu.org Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Sun May 23 23:43:36 2021 Return-path: Envelope-to: geh-help-gnu-emacs@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 1lkvsl-000A62-MJ for geh-help-gnu-emacs@m.gmane-mx.org; Sun, 23 May 2021 23:43:35 +0200 Original-Received: from localhost ([::1]:53756 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lkvsk-0007cU-Ov for geh-help-gnu-emacs@m.gmane-mx.org; Sun, 23 May 2021 17:43:34 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:34002) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lkvsD-0007cJ-3W for help-gnu-emacs@gnu.org; Sun, 23 May 2021 17:43:01 -0400 Original-Received: from stw1.rcdrun.com ([217.170.207.13]:45917) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lkvsB-00051W-0x for help-gnu-emacs@gnu.org; Sun, 23 May 2021 17:43:00 -0400 Original-Received: from localhost ([::ffff:102.87.235.181]) (AUTH: PLAIN admin, TLS: TLS1.3,256bits,ECDHE_RSA_AES_256_GCM_SHA384) by stw1.rcdrun.com with ESMTPSA id 00000000000ADF16.0000000060AACC60.0000166D; Sun, 23 May 2021 14:42:55 -0700 Mail-Followup-To: help-gnu-emacs@gnu.org Content-Disposition: inline In-Reply-To: <87wnrpxian.fsf_-_@zoho.eu> Received-SPF: pass client-ip=217.170.207.13; envelope-from=bugs@gnu.support; helo=stw1.rcdrun.com X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Users list for the GNU Emacs text editor List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "help-gnu-emacs" Xref: news.gmane.io gmane.emacs.help:130149 Archived-At: * Emanuel Berg via Users list for the GNU Emacs text editor [2021-05-24 00:17]: > Jean Louis wrote: > > >>> Is it like outline heading related? > >> > >> Yes. I tried to search for some information but did > >> not find. > > > > I use this settings as I like to have this below as header: > > checkdoc is > > Interactively check the entire buffer for style errors. > The current status of the check will be displayed in > a buffer which the users will view as each check > is completed. > > So why it doesn't report on previous errors that are not > cosmetic but literally brakes installation attempts using > Emacs own facilities (which were unknown to me) I don't know, > but maybe you Jean can write a `verify-header' function to do > it, then they can add it to checkdoc if they fancy it, if not > we can just use it anyway :) > > https://dataswamp.org/~incal/emacs-packs > https://dataswamp.org/~incal/fps/ My opinion is that Emacs is just fine. And I have the workflow. Some programs are in separate files, some are within same file, sometimes functions from one file go out of it and become separate file. When file is usable as an installed package even without my personal environment, then it may become a package. Helpful workflow for preparation of packages: 1. Enable lexical-binding = t, with: {M-x add-file-local-variable-prop-line RET lexical-binding RET t RET} even in cases that you wish to have a package without lexical binding. Compiler warnings will help you find errors. Later you may remove it if really necessary. In majority of cases it should stay with lexical binding; 2. M-x emacs-list-byte-compile, then clear any errors you may find; repeat this step until there are no errors: 3. M-x checkdoc-current-buffer and repeat it until the documentation strings and style are cleared; 4. Invoke M-x package-header for licensing and packaging purposes; 5. M-x package-install-from-buffer or M-x package-install-file may detect issues previously not detected; solve each problem until there are really no errors; sometimes errors shall remain there as they serve the development process; 6. After that should follow same installation of a package and verifications for Emacs stable versions; 7. Once fully error free, your package may be ready for public distribution. -- Jean Take action in Free Software Foundation campaigns: https://www.fsf.org/campaigns Sign an open letter in support of Richard M. Stallman https://stallmansupport.org/