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#48269: 27.1: log-edit-generate-changelog-from-diff FAILURE Date: Sun, 09 May 2021 21:54:44 +0300 Message-ID: <83bl9j7n63.fsf@gnu.org> References: <20210506232308.cd6dfmj566mbzczz@E15-2016.optimum.net> <20210507024717.rvxxe7fkbf2iloag@E15-2016.optimum.net> <83im3vcbej.fsf@gnu.org> <20210509165515.6vg4g3tobx2sok6f@E15-2016.optimum.net> <83mtt37rrp.fsf@gnu.org> <20210509184443.h2jvva6enamdegwd@E15-2016.optimum.net> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="33752"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 48269@debbugs.gnu.org, fgunbin@fastmail.fm To: Boruch Baum Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun May 09 20:55:24 2021 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 1lfoaK-0008fu-59 for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 09 May 2021 20:55:24 +0200 Original-Received: from localhost ([::1]:51652 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lfoaJ-0008Jl-8i for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 09 May 2021 14:55:23 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:48392) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lfoZy-0008JN-MB for bug-gnu-emacs@gnu.org; Sun, 09 May 2021 14:55:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:45069) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lfoZy-0005Cy-C1 for bug-gnu-emacs@gnu.org; Sun, 09 May 2021 14:55:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1lfoZy-0008K2-92 for bug-gnu-emacs@gnu.org; Sun, 09 May 2021 14:55: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: Sun, 09 May 2021 18:55:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 48269 X-GNU-PR-Package: emacs Original-Received: via spool by 48269-submit@debbugs.gnu.org id=B48269.162058649431971 (code B ref 48269); Sun, 09 May 2021 18:55:02 +0000 Original-Received: (at 48269) by debbugs.gnu.org; 9 May 2021 18:54:54 +0000 Original-Received: from localhost ([127.0.0.1]:56615 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lfoZp-0008Jb-Dz for submit@debbugs.gnu.org; Sun, 09 May 2021 14:54:53 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:37998) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lfoZl-0008JM-Hr for 48269@debbugs.gnu.org; Sun, 09 May 2021 14:54:51 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:40482) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lfoZf-000501-Vf; Sun, 09 May 2021 14:54:43 -0400 Original-Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:2554 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lfoZf-0007ku-Iv; Sun, 09 May 2021 14:54:43 -0400 In-Reply-To: <20210509184443.h2jvva6enamdegwd@E15-2016.optimum.net> (message from Boruch Baum on Sun, 9 May 2021 14:44:43 -0400) 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" Xref: news.gmane.io gmane.emacs.bugs:206108 Archived-At: > Date: Sun, 9 May 2021 14:44:43 -0400 > From: Boruch Baum > Cc: fgunbin@fastmail.fm, 48269@debbugs.gnu.org > > > > There could be a sanity-check at the beginning of the function in the form: > > > > > > (unless (eq major-mode foo) > > > (user-error "Not in foo buffer")) > > > > Yes, but my question was about the doc string: if it said the function > > should be invoked from a *vc-log* buffer, would that have helped you? > > Since your original report was against the doc string, I think it's > > important to understand how we could improve it. > > The short answer then, is yes. But the long answer, adding a sanity > check to the code, would avoid needing to look at the docstring. Assuming the text of the user-error message could be detailed enough to make sense. A doc string doesn't have to be short, so it's easier to explain complex stuff there.