From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Philip Kaludercic Newsgroups: gmane.emacs.devel Subject: Re: Fetching or installing package dev source from VCS: manual style Date: Sun, 16 Oct 2022 13:30:29 +0000 Message-ID: <877d0z5216.fsf@posteo.net> References: <164484721900.31751.1453162457552427931@vcs2.savannah.gnu.org> <20220214140020.04438C00891@vcs2.savannah.gnu.org> <87bkqmqpvb.fsf@posteo.net> <871qris3xb.fsf@gnus.org> <877d1aqoc1.fsf@posteo.net> <87edvhqdrb.fsf@gnus.org> <871qrh2hh6.fsf@posteo.net> <87mta5oyec.fsf@gnus.org> <87sfjx10x1.fsf@posteo.net> <875ygsp0ng.fsf@gnus.org> <87h70c9bu4.fsf@posteo.net> <874jw73cjy.fsf@posteo.net> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="3857"; mail-complaints-to="usenet@ciao.gmane.io" Cc: emacs-devel@gnu.org To: Richard Stallman Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sun Oct 16 15:36:26 2022 Return-path: Envelope-to: ged-emacs-devel@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 1ok3oX-0000mq-UR for ged-emacs-devel@m.gmane-mx.org; Sun, 16 Oct 2022 15:36:26 +0200 Original-Received: from localhost ([::1]:49894 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ok3oW-0001PJ-G0 for ged-emacs-devel@m.gmane-mx.org; Sun, 16 Oct 2022 09:36:24 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:56002) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ok3iy-0008AR-KT for emacs-devel@gnu.org; Sun, 16 Oct 2022 09:30:40 -0400 Original-Received: from mout02.posteo.de ([185.67.36.66]:40085) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ok3iw-0001bu-9t for emacs-devel@gnu.org; Sun, 16 Oct 2022 09:30:40 -0400 Original-Received: from submission (posteo.de [185.67.36.169]) by mout02.posteo.de (Postfix) with ESMTPS id D1B06240104 for ; Sun, 16 Oct 2022 15:30:35 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1665927035; bh=HwBLmGolUw9RqpISTeQJRCgDHRYBonfwrX5nzqKLOYc=; h=From:To:Cc:Subject:Autocrypt:Date:From; b=p99BJGL61Iw0nzVL8O+eeb+IaTf5C9zaYgm9xB8/s5Dba5fH+0+R+nBKqBfUvMEUJ GxSt+NFGMXspQ99/zr2WtOFRRiLC9yFcoHRtr5q6vNk+g8vEoXsROP/rN5SwVyxGVL QFSp81CWQ3Z6Q/58uZrUefa647jEKWOhPFMdDGVByKy+TSLTPiVLHU4A0PDF7tTQy9 fhr1zI9LUDf3eNYtHM5lpg/idzsa4kk6IO508iB7XS9VM3VA0uqVJrNFmnnOGDfl0V V1PDOX/miqRWCGkLjECR3TnICIfP3h17RZ394TzuZGk0rlVCf98roQwgKV4BcFM3hv rxKLSnVQzPpeA== Original-Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4Mr1GM1wMYz9rxN; Sun, 16 Oct 2022 15:30:35 +0200 (CEST) In-Reply-To: (Richard Stallman's message of "Sat, 15 Oct 2022 16:43:39 -0400") Autocrypt: addr=philipk@posteo.net; prefer-encrypt=nopreference; keydata= mDMEYHHqUhYJKwYBBAHaRw8BAQdAp3GdmYJ6tm5McweY6dEvIYIiry+Oz9rU4MH6NHWK0Ee0QlBo aWxpcCBLYWx1ZGVyY2ljIChnZW5lcmF0ZWQgYnkgYXV0b2NyeXB0LmVsKSA8cGhpbGlwa0Bwb3N0 ZW8ubmV0PoiQBBMWCAA4FiEEDM2H44ZoPt9Ms0eHtVrAHPRh1FwFAmBx6lICGwMFCwkIBwIGFQoJ CAsCBBYCAwECHgECF4AACgkQtVrAHPRh1FyTkgEAjlbGPxFchvMbxzAES3r8QLuZgCxeAXunM9gh io0ePtUBALVhh9G6wIoZhl0gUCbQpoN/UJHI08Gm1qDob5zDxnIHuDgEYHHqUhIKKwYBBAGXVQEF AQEHQNcRB+MUimTMqoxxMMUERpOR+Q4b1KgncDZkhrO2ql1tAwEIB4h4BBgWCAAgFiEEDM2H44Zo Pt9Ms0eHtVrAHPRh1FwFAmBx6lICGwwACgkQtVrAHPRh1Fw1JwD/Qo7kvtib8jy7puyWrSv0MeTS g8qIxgoRWJE/KKdkCLEA/jb9b9/g8nnX+UcwHf/4VfKsjExlnND3FrBviXUW6NcB Received-SPF: pass client-ip=185.67.36.66; envelope-from=philipk@posteo.net; helo=mout02.posteo.de X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 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-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:297862 Archived-At: Richard Stallman writes: > [[[ To any NSA and FBI agents reading my email: please consider ]]] > [[[ whether defending the US Constitution against all enemies, ]]] > [[[ foreign or domestic, requires you to follow Snowden's example. ]]] > > The proposed manual text includes several sentences which use passive > voice and would be shorter in active voice. Occasionally the use of > passive voice is best approach, but usually not, so please try making > them active and see if that makes the text more readable. > > Please don't refer to a maintainer, singular, as "them". > There are many other ways to write that sentence, and some > don't use a pronoun at all. Thank you for the input, how do you like this: --8<---------------cut here---------------start------------->8--- @node Package from Source @section Package from Source @cindex package development source @cindex package upstream source @cindex package git source @c "git" is not technically correct By default @code{package-install} will download a tarball from a package archive and install the files therein contained. Most of the time this is just what you want. One exception is when you decide to hack on the source code of a package, and would like to share these changes with other users. In that case you usually want to fetch and work on the upstream source, so that you can prepare a usable patch. @findex package-vc-install One way to do this is to use @code{package-vc-install}, to fetch the source code for a package directly from source. The command will also automatically ensure that all files are byte-compiled and auto-loaded, just like with a regular package. Packages installed this way behave just like any other package. You can update them using @code{package-update} or @code{package-update-all} and delete them again using @code{package-delete}. They are even displayed in the regular package listing. @findex package-report-bug @findex package-vc-prepare-patch With the source checkout, you might want to reproduce a bug against the current development head or implement a new feature to scratch an itch. If the package metadata indicates how to contact the maintainer, you can use the command @code{package-report-bug} to report a bug via Email. This report will include all the user options that you have customised. If you have made a change you wish to share with the maintainers, first commit your changes then use the command @code{package-vc-prepare-patch} to share it. @xref{Preparing Patches}. @findex package-vc-link-directory @findex package-vc-refresh If you maintain your own packages you might want to use a local checkout instead of cloning a remote repository. You can do this by using @code{package-vc-link-directory}, which creates a symbolic link from the package directory (@pxref{Package Files}) to your checkout and initialises the code. Note that you might have to use @code{package-vc-refresh} to repeat the initialisation and update the autoloads. --8<---------------cut here---------------end--------------->8---