From owner-svn-doc-head@freebsd.org Sat Jun 22 11:34:21 2019 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 6839715D2882; Sat, 22 Jun 2019 11:34:21 +0000 (UTC) (envelope-from mat@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) server-signature RSA-PSS (4096 bits) client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 096D772FD1; Sat, 22 Jun 2019 11:34:21 +0000 (UTC) (envelope-from mat@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 mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id E780AA068; Sat, 22 Jun 2019 11:34:20 +0000 (UTC) (envelope-from mat@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id x5MBYKVs056925; Sat, 22 Jun 2019 11:34:20 GMT (envelope-from mat@FreeBSD.org) Received: (from mat@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id x5MBYK3l056924; Sat, 22 Jun 2019 11:34:20 GMT (envelope-from mat@FreeBSD.org) Message-Id: <201906221134.x5MBYK3l056924@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: mat set sender to mat@FreeBSD.org using -f From: Mathieu Arnold Date: Sat, 22 Jun 2019 11:34:20 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r53177 - head/en_US.ISO8859-1/books/porters-handbook/pkg-files X-SVN-Group: doc-head X-SVN-Commit-Author: mat X-SVN-Commit-Paths: head/en_US.ISO8859-1/books/porters-handbook/pkg-files X-SVN-Commit-Revision: 53177 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Rspamd-Queue-Id: 096D772FD1 X-Spamd-Bar: -- Authentication-Results: mx1.freebsd.org X-Spamd-Result: default: False [-2.97 / 15.00]; local_wl_from(0.00)[FreeBSD.org]; NEURAL_HAM_MEDIUM(-1.00)[-0.999,0]; NEURAL_HAM_LONG(-1.00)[-1.000,0]; NEURAL_HAM_SHORT(-0.97)[-0.967,0]; ASN(0.00)[asn:11403, ipnet:2610:1c1:1::/48, country:US] X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 22 Jun 2019 11:34:21 -0000 Author: mat Date: Sat Jun 22 11:34:20 2019 New Revision: 53177 URL: https://svnweb.freebsd.org/changeset/doc/53177 Log: Update UCL examples of short and multiline strings Submitted by: dbaio Differential Revision: https://reviews.freebsd.org/D20666 Modified: head/en_US.ISO8859-1/books/porters-handbook/pkg-files/chapter.xml Modified: head/en_US.ISO8859-1/books/porters-handbook/pkg-files/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/pkg-files/chapter.xml Fri Jun 21 19:59:19 2019 (r53176) +++ head/en_US.ISO8859-1/books/porters-handbook/pkg-files/chapter.xml Sat Jun 22 11:34:20 2019 (r53177) @@ -164,39 +164,52 @@ - - UCL allows for two kind of strings, either delimited - by double quotes - "foo", or as a - here document. These two - are equivalent: + + To preserve the compatibility with non + UCL pkg-message + files, the first line of a UCL + pkg-message MUST + be a single + [, and the last line + MUST be a single + ]. + + + <acronym>UCL</acronym> Short Strings + + The message is delimited by double quotes + ", this is used for simple single line + strings: + [ -{ message: "Always displayed" +{ + message: "Simple message" } ] + + + <acronym>UCL</acronym> Multiline Strings + + Multiline strings use the standard here document + notation. The multiline delimiter must + start just after << symbols without + any whitespace and it must consist of + capital letters only. To finish a multiline string, add the + delimiter string on a line of its own without any + whitespace. The message from can be written + as: + [ -{ message: <<EOM -Always displayed +{ + message: <<EOM +Simple message EOM } ] - - The here document delimiter (EOM - here) must be uppercase. - - - - To preserve the compatibility with non - UCL pkg-message - files, the first line of a UCL - pkg-message MUST - be a single - [, and the last line - MUST be a single - ]. - + Always Display a Message