From owner-freebsd-doc@FreeBSD.ORG Fri Feb 13 16:50:08 2004 Return-Path: Delivered-To: freebsd-doc@hub.freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 3145B16A4CE for ; Fri, 13 Feb 2004 16:50:08 -0800 (PST) Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21]) by mx1.FreeBSD.org (Postfix) with ESMTP id 2C34543D2F for ; Fri, 13 Feb 2004 16:50:08 -0800 (PST) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1]) i1E0o8bv069312 for ; Fri, 13 Feb 2004 16:50:08 -0800 (PST) (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.12.10/8.12.10/Submit) id i1E0o8QQ069311; Fri, 13 Feb 2004 16:50:08 -0800 (PST) (envelope-from gnats) Resent-Date: Fri, 13 Feb 2004 16:50:08 -0800 (PST) Resent-Message-Id: <200402140050.i1E0o8QQ069311@freefall.freebsd.org> Resent-From: FreeBSD-gnats-submit@FreeBSD.org (GNATS Filer) Resent-To: freebsd-doc@FreeBSD.org Resent-Reply-To: FreeBSD-gnats-submit@FreeBSD.org, Chuck Swiger Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id E9EF816A4DC for ; Fri, 13 Feb 2004 16:42:29 -0800 (PST) Received: from mail.pkix.net (dpvc-68-161-244-25.ny325.east.verizon.net [68.161.244.25]) by mx1.FreeBSD.org (Postfix) with ESMTP id 63E2D43D1D for ; Fri, 13 Feb 2004 16:42:29 -0800 (PST) (envelope-from chuck@pkix.net) Received: from localhost (localhost [127.0.0.1]) by ns1.pkix.net (Postfix) with ESMTP id 5181D551E; Fri, 13 Feb 2004 19:42:28 -0500 (EST) Received: from mail.pkix.net ([127.0.0.1]) by localhost (ns1.pkix.net [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 52763-02; Fri, 13 Feb 2004 19:42:23 -0500 (EST) Received: by mail.pkix.net (Postfix, from userid 1003) id 0590C5514; Fri, 13 Feb 2004 19:42:22 -0500 (EST) Message-Id: <20040214004222.0590C5514@mail.pkix.net> Date: Fri, 13 Feb 2004 19:42:22 -0500 (EST) From: Chuck Swiger To: FreeBSD-gnats-submit@FreeBSD.org X-Send-Pr-Version: 3.113 cc: kris@obsecurity.org Subject: docs/62808: Update porter's handbook about RESTRICTED et al... X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list Reply-To: Chuck Swiger List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 14 Feb 2004 00:50:08 -0000 >Number: 62808 >Category: docs >Synopsis: Update porter's handbook about RESTRICTED et al... >Confidential: no >Severity: non-critical >Priority: medium >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: doc-bug >Submitter-Id: current-users >Arrival-Date: Fri Feb 13 16:50:07 PST 2004 >Closed-Date: >Last-Modified: >Originator: Chuck Swiger >Release: FreeBSD 4.9-STABLE i386 >Organization: PKIx >Environment: System: FreeBSD ns1.pkix.net 4.9-STABLE FreeBSD 4.9-STABLE #9: Tue Dec 2 16:05:30 EST 2003 root@ns1.pkix.net:/usr/obj/usr/src/sys/NORMAL i386 >Description: Kris Kennaway (wearing his hat?) clarified how RESTRICTED versus NO_CDROM should be used in port Makefiles, and refered to bsd.ports.mk. Based on his comments and that file, I've updated that section of the Porter's Handbook to correspond more closely. >How-To-Repeat: N/A. >Fix: --- book.sgml_orig Fri Feb 13 18:15:59 2004 +++ book.sgml Fri Feb 13 19:22:18 2004 @@ -3416,7 +3416,7 @@ Ports with distribution restrictions - Licenses vary, and some of them place restrictions on how the + Software licenses vary, and some ports have restrictions on how the application can be packaged, whether it can be sold for profit, and so on. @@ -3428,26 +3428,28 @@ please contact the &a.ports;. - In situations like this, the following variables can be set. In - addition, ports/LEGAL should also be - updated. + If a port contains license restrictions, the port + committer should add an entry to ports/LEGAL + describing exactly what the license restriction entails. + In addition, the following variables should be set in the + port's Makefile: + - <makevar>NO_PACKAGE</makevar> - - This variable indicates that we may not generate a binary - package of the application. However, the port's - DISTFILES files may be freely distributed. + <makevar>RESTRICTED</makevar> - NO_PACKAGE should also be used if the binary - package is not generally useful, and the application should always - be compiled from the source code. For example, if the application - has configuration information that is site specific hard coded in to - it at compile time, set NO_PACKAGE. + Set this variable if the application's license forbids us + from mirroring the application's DISTFILES or + distributing pre-built packages of the port via FTP or CD-ROM. + - NO_PACKAGE should be set to a string - describing the reason why the package should not be - generated. + RESTRICTED should be set to a string + describing the reason why the port cannot be redistributed. + Typically, this indicates that the port contains proprietary + software and that the user will need to manually download the + DISTFILES for themselves, possibly after + registering for the software or agreeing to accept the terms of + an EULA. @@ -3455,29 +3457,36 @@ This variable indicates that although we are allowed to generate binary packages, we are not allowed to put those packages, or the - port's DISTFILES, onto a CDROM (or DVD-ROM) - for resale. The - DISTFILES will still be available via FTP - (or HTTP if you set it up that way.) + port's DISTFILES, onto a CD-ROM (or DVD-ROM) + for resale. However, the prebuilt binary packages and the port's + DISTFILES will still be available via FTP. - NO_PACKAGE and NO_CDROM - can be set simultaneously. + NO_CDROM should be set to a string + describing the reason why the port cannot be redistributed + on CD-ROM. For instance, this should be used if the port's license + is for "non-commercial" use only. - <makevar>RESTRICTED</makevar> + <makevar>NO_PACKAGE</makevar> - Set this variable if the application's license also forbids us - from mirroring the application's DISTFILES via - FTP (or HTTP if you set it up that way.) + This variable indicates that we may not generate a binary + package of the application. However, the port's + DISTFILES files may be freely distributed. - Also set this if the application's license has general - restrictions on who may use it, e.g. the application is for - non-commercial use only. + NO_PACKAGE should also be used if the binary + package is not generally useful, and the application should always + be compiled from the source code. For example, if the application + has configuration information that is site specific hard coded in to + it at compile time, set NO_PACKAGE. - Note that the port committer should add an entry to - /usr/ports/LEGAL describing exactly - what the restriction entails. + NO_PACKAGE should be set to a string + describing the reason why the package should not be + generated. + + + NO_PACKAGE and NO_CDROM + can be set simultaneously. @@ -3486,6 +3495,15 @@ If only some of the distribution files are restricted then set this variable to list them. It defaults to ${DISTFILES} ${PATCHFILES}. + + + + Related variables + + In addition to the variables above, a port may also be marked as + BROKEN, FORBIDDEN, or + IGNORE. Please refer to the following section + for additional details: . >Release-Note: >Audit-Trail: >Unformatted: