From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Noam Postavsky Newsgroups: gmane.emacs.bugs Subject: bug#28863: 26.0.90; [PATCH] Don't clobber docstrings of explicitly-defined mode hook variables Date: Sat, 21 Oct 2017 19:03:08 -0400 Message-ID: <874lqsdryr.fsf@users.sourceforge.net> References: <0e9fedfc-ee21-3c9b-2455-17ae5f128d7f@orcon.net.nz> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: blaine.gmane.org 1508627057 32631 195.159.176.226 (21 Oct 2017 23:04:17 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Sat, 21 Oct 2017 23:04:17 +0000 (UTC) User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.0.90 (gnu/linux) Cc: 28863@debbugs.gnu.org To: Phil Sainty Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sun Oct 22 01:04:11 2017 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1e62oI-0006tm-9c for geb-bug-gnu-emacs@m.gmane.org; Sun, 22 Oct 2017 01:04:06 +0200 Original-Received: from localhost ([::1]:59463 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1e62oO-00005Y-1p for geb-bug-gnu-emacs@m.gmane.org; Sat, 21 Oct 2017 19:04:12 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:55338) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1e62oH-0008W5-Ci for bug-gnu-emacs@gnu.org; Sat, 21 Oct 2017 19:04:06 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1e62oE-0008V1-8h for bug-gnu-emacs@gnu.org; Sat, 21 Oct 2017 19:04:05 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:46057) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1e62oE-0008Ui-3F for bug-gnu-emacs@gnu.org; Sat, 21 Oct 2017 19:04:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1e62oD-0001Xv-Qq for bug-gnu-emacs@gnu.org; Sat, 21 Oct 2017 19:04:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Noam Postavsky Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 21 Oct 2017 23:04:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 28863 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 28863-submit@debbugs.gnu.org id=B28863.15086270015892 (code B ref 28863); Sat, 21 Oct 2017 23:04:01 +0000 Original-Received: (at 28863) by debbugs.gnu.org; 21 Oct 2017 23:03:21 +0000 Original-Received: from localhost ([127.0.0.1]:54738 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1e62nX-0001Wr-AU for submit@debbugs.gnu.org; Sat, 21 Oct 2017 19:03:19 -0400 Original-Received: from mail-it0-f49.google.com ([209.85.214.49]:57081) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1e62nV-0001WZ-Ho; Sat, 21 Oct 2017 19:03:17 -0400 Original-Received: by mail-it0-f49.google.com with SMTP id r127so2262709itb.5; Sat, 21 Oct 2017 16:03:17 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:references:date:in-reply-to:message-id :user-agent:mime-version; bh=cVjPSpZxn+vgWC1cdU+FxVRCs9Pnovzji4KJlILeQ6g=; b=itplCj9TinzKv/ghHrD55zc6oQ7nKYMT+aLYAnushvLhUcAFhiJzJsUU2Dfo+nfPuc 556C6u+QJulcTP+ICXZ5RALfqTQFoXx1coEk4ae2QqKjnGAUMNAokMzD8AERH7eFvnmu yfB196NEjyZeCF1lBYLADfh1F+BOPNhAkRVnxSZmL0YyK0t275jf049+M8oqxl34+Roz Q8tEyVfRDKWXvIAbulmhwv6lSuGKNuJSUruiJTd3OLjbJF92ZLheWYD4JpBDPksHc/rc uF4lX296kGv3NX5nKdjLv5q1VMlX7GohzVcDK0wM+z4nhSNfDoa0Mjldv09mGpHMc9/u Sk4A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:references:date :in-reply-to:message-id:user-agent:mime-version; bh=cVjPSpZxn+vgWC1cdU+FxVRCs9Pnovzji4KJlILeQ6g=; b=HLjNcS2q0syjqrxZ14kgFYkvHpvNBRuL106BKgW1N4yTSdrrS2cl8NXkFQ4gJkkIea LKxBWUaOhdJWXQTTSGbsDF14+jkVnzrXBonCPKqhvi87zW0hbbW4te6I2dBJmi8fipv+ byXhmpkM/Rl8LiLQLmoZjrNoON7oElR59zxBdzS2yhGqvmzi+hL7BkPvNlsCDIUsCdqm PKHJz0Xeo0CPbXDbW1NlVjj3o7SKISOlqBW6eQ4Tdpz9BEhfe2o0Liakkzlnz4umAnEh 9tnB+wblQYDg9c25e3mMicJNlVg1zzoP/zCPoMHJHtthF78Q58M5Z0u4Q62im382Cc7I gOMQ== X-Gm-Message-State: AMCzsaXxzBmrA/km2qsOjHW9uVmgZjYDRmv6EJqt6lPD0T0kHvy5Xp+O E7B7DhM5NsKTrO95FLyIdN/5Sw== X-Google-Smtp-Source: ABhQp+TcRkYyTCY4ttNdozm0ogksOKtEzR57K3XpudqmPQe6nx2wbo/vYWDhhMmSU5F6OyRAIEY+8A== X-Received: by 10.36.249.4 with SMTP id l4mr3708597ith.20.1508626991569; Sat, 21 Oct 2017 16:03:11 -0700 (PDT) Original-Received: from zebian ([45.2.119.34]) by smtp.googlemail.com with ESMTPSA id l65sm881364itb.6.2017.10.21.16.03.09 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Sat, 21 Oct 2017 16:03:09 -0700 (PDT) In-Reply-To: <0e9fedfc-ee21-3c9b-2455-17ae5f128d7f@orcon.net.nz> (Phil Sainty's message of "Tue, 17 Oct 2017 01:35:43 +1300") X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.43 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.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:138829 Archived-At: severity 28863 minor quit Phil Sainty writes: > 1. If the mode is defined first: > > (define-derived-mode foo-mode ...) > (defcustom foo-mode-hook '(default value) "docstring") > > Then `foo-mode-hook' has already been defvar'd with a value of nil, > and so the defcustom default value never gets set, so that sequence > is no good. Giving a default value to a hook variable is problematic, because if the user has (add-hook 'foo-mode-hook 'some-other-fun) then they lose the default-value if foo-mode.el wasn't loaded yet. So the usual way to do it is like this: (defcustom foo-mode-hook nil "docstring") (add-hook 'foo-mode-hook 'default-value) > My suggestion is that `define-derived-mode' and `define-minor-mode' > should only add the standard docstring to the mode hook variable > conditional on that variable not *already* having a docstring. Seems fine to me. > Patch attached for consideration. My only nitpick is that you seem to be adding tab-indented lines.