From owner-svn-doc-all@freebsd.org Sat Dec 30 20:49:26 2017 Return-Path: Delivered-To: svn-doc-all@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 58DDDEABBF9; Sat, 30 Dec 2017 20:49:26 +0000 (UTC) (envelope-from adamw@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id 229D46C34D; Sat, 30 Dec 2017 20:49:26 +0000 (UTC) (envelope-from adamw@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id vBUKnPRH024926; Sat, 30 Dec 2017 20:49:25 GMT (envelope-from adamw@FreeBSD.org) Received: (from adamw@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id vBUKnPfi024925; Sat, 30 Dec 2017 20:49:25 GMT (envelope-from adamw@FreeBSD.org) Message-Id: <201712302049.vBUKnPfi024925@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: adamw set sender to adamw@FreeBSD.org using -f From: Adam Weinberger Date: Sat, 30 Dec 2017 20:49:25 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r51347 - head/en_US.ISO8859-1/books/porters-handbook/special X-SVN-Group: doc-head X-SVN-Commit-Author: adamw X-SVN-Commit-Paths: head/en_US.ISO8859-1/books/porters-handbook/special X-SVN-Commit-Revision: 51347 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-all@freebsd.org X-Mailman-Version: 2.1.25 Precedence: list List-Id: "SVN commit messages for the entire doc trees \(except for " user" , " projects" , and " translations" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 30 Dec 2017 20:49:26 -0000 Author: adamw (ports committer) Date: Sat Dec 30 20:49:24 2017 New Revision: 51347 URL: https://svnweb.freebsd.org/changeset/doc/51347 Log: Add a section on shell completion files. Basically, always install them, and never register RUN_DEPENDS on the shells themselves. Approved by: mat (doc hat) Differential Revision: https://reviews.freebsd.org/D13696 Modified: head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml Modified: head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml Fri Dec 29 16:37:22 2017 (r51346) +++ head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml Sat Dec 30 20:49:24 2017 (r51347) @@ -5523,4 +5523,41 @@ GROUPS= pulse pulse-access pulse-rt + + + Shell Completion Files + + Many modern shells (including bash, tcsh, and zsh) support + parameter and/or option tab-completion. This support usually + comes from completion files, which contain the definitions for + how tab completion will work for a certain command. Ports + sometimes ship with their own completion files, or porters may + have created them themselves. + + When available, completion files should always be + installed. It is not necessary to make an option for it. + If an option is used, though, always enable it in + OPTIONS_DEFAULT. + + + Shell completion file paths + + + + + bash + ${PREFIX}/etc/bash_completion.d + + + + zsh + ${PREFIX}/share/zsh/site-functions + + + +
+ + Do not register any dependencies on the shells + themselves. +