From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Ihor Radchenko Newsgroups: gmane.emacs.devel,gmane.emacs.orgmode Subject: [FWD from emacs-orgmode] Re: Bug: About org-submit-bug-report [9.3 (release_9.3 @ /usr/local/share/emacs/27.0.50/lisp/org/)] Date: Fri, 20 Dec 2019 17:18:33 +0800 Message-ID: <87zhfntkwm.fsf@gmail.com> References: <87sglf3k9r.fsf@web.de> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="73909"; mail-complaints-to="usenet@blaine.gmane.org" Cc: Michael Heerdegen , emacs-orgmode@gnu.org To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Fri Dec 20 10:20:45 2019 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1iiESj-000J6F-4h for ged-emacs-devel@m.gmane.org; Fri, 20 Dec 2019 10:20:45 +0100 Original-Received: from localhost ([::1]:52178 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iiESh-00023N-5E for ged-emacs-devel@m.gmane.org; Fri, 20 Dec 2019 04:20:43 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:44569) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iiESa-00020u-6Q for emacs-devel@gnu.org; Fri, 20 Dec 2019 04:20:37 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iiESY-000865-TN for emacs-devel@gnu.org; Fri, 20 Dec 2019 04:20:35 -0500 Original-Received: from mail-yb1-xb44.google.com ([2607:f8b0:4864:20::b44]:41964) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iiESY-00082q-Hg; Fri, 20 Dec 2019 04:20:34 -0500 Original-Received: by mail-yb1-xb44.google.com with SMTP id b145so3306862yba.8; Fri, 20 Dec 2019 01:20:34 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:in-reply-to:references:date:message-id :mime-version; bh=hqL8FCbV1lupt1bUInUi6uqbj94Y4Fhay8Pts2Ei92s=; b=kzy4bTRI2qMwLKdwkhiM0dw8IavmoiDaAKaQ1UGxnJiDPvBjEhP5ffMB6EkfT2CMY7 2pSRjlyRHIP5hm+wp7+uB9d7r/eKgBghBCYKEYtEj9yTs5ZnqR/hmKfNCJqC7IQ9kcWe v32x6sBRHxjSZRfLaUvkBNETze/lZYz8c6tBB7H3Z6Pz+8Ekr5uSoqMPvSLGR/Y/ViNN 5hq45wb4d0L7F+cKQYKJuLvDqY/+HuAJKXBg6LDItdWsFRKdY+pxxPe2iFgR6hbJuTCu /xeLWFMf4ncVlLIzKrxL0pUtRTmsGvL9OTajDUYyIehxOGKwhLdWrMaSvX2SLKiVbyR3 EL6w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:in-reply-to:references:date :message-id:mime-version; bh=hqL8FCbV1lupt1bUInUi6uqbj94Y4Fhay8Pts2Ei92s=; b=ds9sE6iwKAy37dvCSJeFXJle/oq9IeOtFeHrKhX97J9l7+vXSAKpvCd2N+prp4Chze uvNmBDeYQGA8IMJY70kjMjqDVYV6iDuMWAE1kxNa2/zoOpUM66B5ouAvnUIo2KrtdagM 5rJqGItGeb89PkWXgtE9CQq9mhxG53Q3o6IOx+q6s7+j0a9jv3Pur/slayAfCPi6ge6w GpoXW/ZzODvGjbnFd9DUkyx/3/0S0mRTAsAbObepOrvEG1t0OxspfCDtymdhpWh9ZpWa 7hnjzi6+q0RO2jDnVuZBVam2FrmYS08LCT4y6VhKLdepLOB+57zxoLqEluN3NVn9vMJ0 AoRA== X-Gm-Message-State: APjAAAUyiqcT7vWDyZvNC4BfQiLWBKNy9zYZAab/G2o7eGxBEP9cul7X FNX9hQSZ+O8cyMyFdoc8zhVrvsPSI82OhA== X-Google-Smtp-Source: APXvYqwByCCHTf8Sr7QgdmFcmVAFrDxlday3HmZuSzxC5ajdPrVQL+zYINF4IZsE3w1//NLTUJRDcw== X-Received: by 2002:a25:4609:: with SMTP id t9mr10020986yba.175.1576833633581; Fri, 20 Dec 2019 01:20:33 -0800 (PST) Original-Received: from localhost ([5.226.137.4]) by smtp.gmail.com with ESMTPSA id r64sm3778732ywg.84.2019.12.20.01.20.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 20 Dec 2019 01:20:32 -0800 (PST) In-Reply-To: <87sglf3k9r.fsf@web.de> X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2607:f8b0:4864:20::b44 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 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.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.org gmane.emacs.devel:243503 gmane.emacs.orgmode:126529 Archived-At: [Forwarding this to emacs-devel] The naming convention for mode-specific bug reporting seems to be confusing. The bug reporting functions are often not easy to discover without knowing the explicit command name (especially with emacs default completion interface). For example see recent message in emacs-orgmode (below). > I want to suggest to make `report-org-bug' and alias for the command > `org-submit-bug-report'. That's the name I expected (considering > "report-emacs-bug"), also some other Emacs packages name their bug > reporting command according to this scheme. The additional name would > make this important command more discoverable. Another convention for bug report command is *mode*-report-bug/*mode*-bug-report: calc-report-bug reftex-report-bug eshell-report-bug gnuplot-bug-report c-submit-bug-report Though several modes are also using the naming similar to org-submit-bug-report: c-submit-bug-report diredp-send-bug-report org-edna-submit-bug-report I am thinking if it would make sense to develop more standardised command name conventions for bug reporting and add them to (elisp)Emacs Lisp:Preparing Lisp code for distribution Then, the built-in emacs packages might be changed to follow those conventions and improve discoverability of bug reporting capabilities. Also, an information that different major modes may have they own bug reporting tools might be mentioned in the default template shown in report-emacs-bug. What do you think? Regards, Ihor Michael Heerdegen writes: > Hello, > > I want to suggest to make `report-org-bug' and alias for the command > `org-submit-bug-report'. That's the name I expected (considering > "report-emacs-bug"), also some other Emacs packages name their bug > reporting command according to this scheme. The additional name would > make this important command more discoverable. > > Second point: When you think it is a trivial task for a common user > please consider to add some text to the initial buffer contents of the > message buffer created by this command explaining where one can search > for existing reports (to avoid duplicates and reports about things that > are just pitfalls etc). My buffer included a link to a page explaining > how to create a good report but there this information is also missing, > although I think it would be a good place. > > TIA, > > Michael. > > Emacs : GNU Emacs 27.0.50 (build 41, x86_64-pc-linux-gnu, GTK+ Version 3.24.13) > of 2019-12-20 > Package: Org mode version 9.3 (release_9.3 @ /usr/local/share/emacs/27.0.50/lisp/org/) >