From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#72735: 31.0.50; [PATCH] Make more bug-reference variables customizeable Date: Tue, 20 Aug 2024 21:39:34 +0300 Message-ID: <86wmkbujh5.fsf@gnu.org> References: <874j7fnr75.fsf@> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="31006"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 72735@debbugs.gnu.org To: =?UTF-8?Q?Bj=C3=B6rn?= Bidar Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Tue Aug 20 20:40:44 2024 Return-path: Envelope-to: geb-bug-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 1sgTme-0007pi-8p for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 20 Aug 2024 20:40:44 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sgTmM-0007Vp-Si; Tue, 20 Aug 2024 14:40:27 -0400 Original-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 1sgTmF-0007VU-Le for bug-gnu-emacs@gnu.org; Tue, 20 Aug 2024 14:40:20 -0400 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1sgTmE-0003KY-W1 for bug-gnu-emacs@gnu.org; Tue, 20 Aug 2024 14:40:19 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=debbugs.gnu.org; s=debbugs-gnu-org; h=MIME-version:References:In-Reply-To:From:Date:To:Subject; bh=9yUOgLmjjgCQYDtIaU+/jOMrM5D+/+uacUwdEvbWoMk=; b=SrRVDBLFYW+dVtPwv57KQpwscE/n50haJOsnWo6LULYzcdkEs9trYN5ieGYePXQ4Xtu13cBU1wXqoerwRt197yWYFYgkNAm5KcgmKnT8u1s8DFMT5Him49zdmrQ3oIF2u4S8c/Q5TmbTarKtNcqXYrBhXSL7vyPHID4vwLAO20xb1lvj6W0waZNyoAV0Fn6jcRglwniYygno3sLyJvia6kDroEHx+QU/pM0ZeJhJ0bBdoM/rJoyfv3rjpvyju8ixJmcB2yybQVQ2eUgJFskkYCnKB5GakntPdnVz0GYmLhc3hHg/3xAGNxWOz3yQh8xrE7ZUdC0fWRk1PyZ5BRk14Q==; Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1sgTmw-0002bN-3E for bug-gnu-emacs@gnu.org; Tue, 20 Aug 2024 14:41:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 20 Aug 2024 18:41:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 72735 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 72735-submit@debbugs.gnu.org id=B72735.17241792299934 (code B ref 72735); Tue, 20 Aug 2024 18:41:02 +0000 Original-Received: (at 72735) by debbugs.gnu.org; 20 Aug 2024 18:40:29 +0000 Original-Received: from localhost ([127.0.0.1]:33644 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sgTmP-0002aA-Ek for submit@debbugs.gnu.org; Tue, 20 Aug 2024 14:40:29 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:45660) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sgTmM-0002Zu-VV for 72735@debbugs.gnu.org; Tue, 20 Aug 2024 14:40:28 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sgTlZ-00035g-W3; Tue, 20 Aug 2024 14:39:38 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-version:References:Subject:In-Reply-To:To:From: Date; bh=9yUOgLmjjgCQYDtIaU+/jOMrM5D+/+uacUwdEvbWoMk=; b=dvihM2Upvo1Hn3UAOSSV RnMxTf5SJ/f6FIgM7DOtiOHHvCsFoKhpK2lJy/iKMCm2JESzH29FnePelE7g6NRjGJIxh11uv9J1L 8kCNaL5v1Bl8KAaH5/Kj45yHW8HFEmwf3Ly4ahnVYIRMEi/2Rw0ymZXUE0gvgazDMeySFvCSY5wjw B/C7M5W8gqReyYU1eJGBYv/bjdkFnIZiVJpTgJe2QSzbmjKzbILpSJ6rKZVtl5WLLeU1uKSuI985e MCu4lbgLtBMufTi427nVhi1aA4jbY90OmcnBUu9tF56rOE95Vod42WPgTVfHLhtTkrQJIBMNPoG3L T2ptSSpK3NhczA==; In-Reply-To: <874j7fnr75.fsf@> (bug-gnu-emacs@gnu.org) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:290462 Archived-At: > Date: Tue, 20 Aug 2024 18:34:38 +0300 > From: Björn Bidar via "Bug reports for GNU Emacs, > the Swiss army knife of text editors" > > I noticed that some of the variables that can be modified > by the user or as mentioned as such were not defined as custom variable. > These patches to so and correct the group of one of the existing > defcustom. > > The patches don't change any of the existing functionality > but only document these variables better and make them easier to modify. > Because of that I set version to Emacs 30.1. Please tell if that's ok. The emacs-30 release branch is closed to enhancements, it only receives bugfix changes and improvements in documentation. Converting a defvar to a defcustom is not just a documentation change, it radically changes how the variable is initialized and set. So this is not appropriate for the release branch. Please see several comments below. > * lisp/progmodes/bug-reference.el (bug-reference-url-format): Define as > custom type. The manual and the documentation string talk like the ^^ > variable like is a custom variable. It does make sense to define ^^ Our convention is to leave two spaces between sentences in comments, strings, and commit log messages. There are several places in the patch where you left only one space. > -(defvar bug-reference-url-format nil > +(defcustom bug-reference-url-format nil > "Format used to turn a bug number into a URL. I wonder how this makes sense as a defcustom, since this variable must be file-local, AFAIU. In any case, the doc string should explain the semantics of the nil value. > + :group 'bug-reference) This is redundant (here and elsewhere in the patches), since the package name will supply the group. > +FORGE-TYPE is the type of the forge, e.g., gitlab, gitea, > +sourcehut, or github. This leaves it unsaid how these symbols are used, and what symbols are recognized. Finally, I think this warrants a NEWS entry. Thanks.