From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp1 ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id 2PH+CT9xv2COwgAAgWs5BA (envelope-from ) for ; Tue, 08 Jun 2021 15:31:43 +0200 Received: from aspmx1.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp1 with LMTPS id wMQ5BT9xv2DBPwAAbx9fmQ (envelope-from ) for ; Tue, 08 Jun 2021 13:31:43 +0000 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id CC59C18461 for ; Tue, 8 Jun 2021 15:31:42 +0200 (CEST) Received: from localhost ([::1]:45364 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lqbpV-00008R-TK for larch@yhetil.org; Tue, 08 Jun 2021 09:31:41 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:44026) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lqbpM-000089-4l for guix-devel@gnu.org; Tue, 08 Jun 2021 09:31:32 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]:33304) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lqbpL-0002ue-Cl; Tue, 08 Jun 2021 09:31:31 -0400 Received: from [2a01:e0a:1d:7270:af76:b9b:ca24:c465] (port=34248 helo=ribbon) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lqbpL-0004h2-4T; Tue, 08 Jun 2021 09:31:31 -0400 From: =?utf-8?Q?Ludovic_Court=C3=A8s?= To: "Paul A. Patience" Subject: Re: What is the standard path for documentation? References: X-URL: http://www.fdn.fr/~lcourtes/ X-Revolutionary-Date: 20 Prairial an 229 de la =?utf-8?Q?R=C3=A9volution?= X-PGP-Key-ID: 0x090B11993D9AEBB5 X-PGP-Key: http://www.fdn.fr/~lcourtes/ludovic.asc X-PGP-Fingerprint: 3CE4 6455 8A84 FDC6 9DB4 0CFB 090B 1199 3D9A EBB5 X-OS: x86_64-pc-linux-gnu Date: Tue, 08 Jun 2021 15:31:29 +0200 In-Reply-To: (Paul A. Patience's message of "Wed, 02 Jun 2021 16:37:38 +0000") Message-ID: <87lf7kfpou.fsf@gnu.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.2 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-BeenThere: guix-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Development of GNU Guix and the GNU System distribution." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: "guix-devel@gnu.org" Errors-To: guix-devel-bounces+larch=yhetil.org@gnu.org Sender: "Guix-devel" X-Migadu-Flow: FLOW_IN ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1623159102; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=Jbl10v28dwfF0sl8JVlA2qHjaYdHsUKBiVgjBhKr+D0=; b=PYRxDGqeIOP2lY9jyFaUX8wT6WhgtGuPZnFYD9lbXbE2cA8Zi1d/74UZ8a0/lf/8TMKy6Q B07yci20eUTB5Ke9t52zVao4MR0fWE+lLdt0qyVbMcFEGeN5lyzEv4AxZ2tpj2D/NKZBHL IPYQXe437x00q32oewuycS5f5JprkJ9p3T/HJEkxzYMssB3PKt91O7Wf78O6QJz4wgHpor 1xEwoz8zSdkBRqq4Usdx1XBE79Zw7JDbdg6cnLq1L7SFvGJGz2rK9x+3bLRFq8TeNB4dga LEVcagPRFzywUHHoMK/ElyjvICLZYOOj9KXItFnWdBwoIy3L5jlpQFlRK2ps/Q== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1623159102; a=rsa-sha256; cv=none; b=R6+57xzsJUkyFdxctl+9wsaPPZBc+z7NFdKGCaGFCieSz1UeB3rEMdT1O8qFSQuPGEFHt4 4icMGDgYdBqeVb0OPxbZYzSBXcj1xCtUhQv8CoYPMCVGNR6c8M9kT0JQwG4ug0+u7VacTf PlmUgXXtoYN5d9mH/fRRpyrxza+alSTjh0hkufBbUyyzkI2UK9lzytTtV12hgs34TEkMGK L0uHNLuHY1QPjc3/eD8ijQ99XJjh+nnFHl3sBaFB15iQdPclOhVyBZWKXj2mcKsqh1EY+x X2GJxEkuLYp0mQX6blG9PEsNNSfNqmlmHlCL5A11xTh7B4/7GdPqNIWZ2iJbYQ== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=none; dmarc=pass (policy=none) header.from=gnu.org; spf=pass (aspmx1.migadu.com: domain of guix-devel-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=guix-devel-bounces@gnu.org X-Migadu-Spam-Score: -1.92 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=pass (policy=none) header.from=gnu.org; spf=pass (aspmx1.migadu.com: domain of guix-devel-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=guix-devel-bounces@gnu.org X-Migadu-Queue-Id: CC59C18461 X-Spam-Score: -1.92 X-Migadu-Scanner: scn0.migadu.com X-TUID: NnOERRcqLemJ Hi Paul, "Paul A. Patience" skribis: > What is the standard place to put documentation? > The license files are automatically installed to the > share/doc/NAME-VERSION directory > (see install-licence-files in gnu-build-system.scm), > but it seems like various packages install the actual > documentation to share/doc/NAME. Right, share/doc/NAME appears to be more common (perhaps we should fix =E2=80=98install-licence-files=E2=80=99). > Also, is it alright for files in the documentation directories > to refer to various other directories in the store? > Deal.II installs the attached files as documentation, but > I thought I saw the source of a Guix package make an attempt > to strip build directory information from one of its output > files. Reference to the build directories are not great but OK. However, the two log files you mention refer to build-time tools. As a result, if you install those, the total size reported by =E2=80=98guix size dealii=E2=80=99 will be noticeably bigger because the set of =E2=80=9Crefer= ences=E2=80=9D (run-time dependencies) would not include things like GCC and so on, even though they are not actually used at run time. Thus, I would not install these two files, especially since they seem to be redundant with Guix-supported provenance tracking. HTH! Ludo=E2=80=99.