From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:47770) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eDz14-0004YY-4a for guix-patches@gnu.org; Sun, 12 Nov 2017 15:38:07 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eDz10-0005C6-6I for guix-patches@gnu.org; Sun, 12 Nov 2017 15:38:06 -0500 Received: from debbugs.gnu.org ([208.118.235.43]:56790) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1eDz10-0005C0-16 for guix-patches@gnu.org; Sun, 12 Nov 2017 15:38:02 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1eDz0z-0007sw-Qs for guix-patches@gnu.org; Sun, 12 Nov 2017 15:38:01 -0500 Subject: [bug#29271] [PATCH 1/1] doc: Split the "Substitutes" section into subsections. Resent-Message-ID: Received: from eggs.gnu.org ([2001:4830:134:3::10]:47510) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eDyzq-00049R-RD for guix-patches@gnu.org; Sun, 12 Nov 2017 15:36:54 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eDyzm-0004qs-Rb for guix-patches@gnu.org; Sun, 12 Nov 2017 15:36:50 -0500 Received: from out4-smtp.messagingengine.com ([66.111.4.28]:42585) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1eDyzm-0004qc-NW for guix-patches@gnu.org; Sun, 12 Nov 2017 15:36:46 -0500 Date: Sun, 12 Nov 2017 15:36:44 -0500 From: Leo Famulari Message-ID: <20171112203644.GB10629@jasmine.lan> References: <20171112110233.1384-1-cmmarusich@gmail.com> <20171112110558.1447-1-cmmarusich@gmail.com> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="RASg3xLB4tUQ4RcS" Content-Disposition: inline In-Reply-To: <20171112110558.1447-1-cmmarusich@gmail.com> List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+kyle=kyleam.com@gnu.org Sender: "Guix-patches" To: Chris Marusich Cc: 29271@debbugs.gnu.org, myglc2@gmail.com --RASg3xLB4tUQ4RcS Content-Type: text/plain; charset=us-ascii Content-Disposition: inline On Sun, Nov 12, 2017 at 03:05:58AM -0800, Chris Marusich wrote: > * doc/guix.texi (Substitutes): Move information into sections, and create one > new subsection regarding substitution failure. > (Top): In the detailed listing, add entries for the new subsections. > (Hydra): Move info about Hydra here. Add information that explains when > substitutes are enabled by default. > (Substitute Server Authorization): Move information about how to enable or > disable substitutes here. > (Substitute Authentication): Move information about how Guix authenticates > substitutes here. > (Proxy Settings): Move information about how to download substitutes via > proxy here. > (Substitution Failure): New section. Add information about how Guix handles > substitution failure. Be extra clear about behavior concerning --fallback. > (On Trusting Binaries): Move information about trusting binaries here. > (Invoking guix-daemon): Remove an incorrect statement about when substitutes > are enabled by default. > (Common Build Options): Clarify the behavior of --fallback. Hi, thanks for your efforts to improve the documentation. Personally, I find it impossible to read diffs of natural language text; it just doesn't work for me like it does with code. So, I will just ask, does this duplicate instructions regarding substitutes in other sections? We should be careful to avoid that. > +@anchor{fallback-option} > @item --fallback > -When substituting a pre-built binary fails, fall back to building > -packages locally. > +Attempt to build locally instead of issuing an error when substitutes > +are enabled and a substitute is available, but the substitution attempt > +fails (@pxref{Substitution Failure}). I was able to read this smaller change. I think the new sentence is too byzantine. I know what --fallback does but I found this sentence hard to understand. The condition that determines whether we "attempt to build locally" should be at the beginning of the sentence, like this: "When substitutes are enabled and a substitute is available, but the substitution fails, fall back to building the derivation locally." This is basically the same as before, but with some more detail about the condition. --RASg3xLB4tUQ4RcS Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQIzBAABCAAdFiEEsFFZSPHn08G5gDigJkb6MLrKfwgFAloIsNwACgkQJkb6MLrK fwixcw//adZ31mE7voZJWShRpeU0IkAF3RHk0SLCSS84qbQ0HIFQ80wxoNzzWSTL wNMViOk+O9As7PdFwNwwipc8OEJkAbmID1Tc9x6prR5O8c3pm8WYSV8x8C4TC2ew oAEStV4olVWaqsUUpJvyZYhZbKPihQb5x6fon1DEVGtqQpoWN6+mpJBQO/e7Vrd1 IqTHW2tNr7wxTCY3fkmOMuN9OqJ4qLKhqenWzke3ZzEfCk88dFOenjklQdEEVE0g IakNAg38I84BszXppqoyX2nGRp1EhMiE6lMm7TY34sZiAMjh2kh3QbxUqQ7ueg5W sWBTztc0lkluppuaekhgo11NY/IQQZmdyHgc06QJ8Jh79xk+eGD7vb21Kz5g7wHo W51TyvFtrWl7SMQcvw8Y5OKtu1gjccacvdC7yeA7O/vlSh+VFh1nVaXDgIV9Kfcl lP8fxzRv7jbTI7NO5wg3xjVIXzRkKPvVPKnawVQvz07QmiP0rdJ+yZrlrd1YolEO wLZdJAkkIELBfGQCpIIxhbLzvxC1womCCT/dvHGMBVWaXuaEFIdHja8QmcIylgGd fijqHOgzzI4jjI0On+Cg+o1CJMg2DX1Jng5KWFS7K/9MDM4mEd3s9Nb1U6gi6D1/ Hv1zpJJlhZHn6xLTq6FseC+JQftqaBmZvOEFGIpBKE0tx1BhlVo= =vCJO -----END PGP SIGNATURE----- --RASg3xLB4tUQ4RcS--