[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/

2023-10-21 Thread Ulrich Müller
commit: c97926baf8da7cf327509a0cd8718ca2bb9db56e
Author: Ulrich Müller  gentoo  org>
AuthorDate: Sat Oct 21 07:54:31 2023 +
Commit: Ulrich Müller  gentoo  org>
CommitDate: Sat Oct 21 19:05:40 2023 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=c97926ba

function-reference/install-functions: Mention dosym -r option

Closes: https://bugs.gentoo.org/916017
Signed-off-by: Ulrich Müller  gentoo.org>

 function-reference/install-functions/text.xml | 15 ++-
 1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/function-reference/install-functions/text.xml 
b/function-reference/install-functions/text.xml
index 0602c80..0d37980 100644
--- a/function-reference/install-functions/text.xml
+++ b/function-reference/install-functions/text.xml
@@ -278,11 +278,16 @@ The *into functions create the directory if it 
does not already exist.
   dosym
 
 
-  Create a symlink to the target specified as the first parameter,
-  at the path specified by the second parameter. Note that
-  the target is interpreted verbatim; it needs to either
-  specify a relative path or an absolute path including
-  ${EPREFIX}.
+  
+  Create a symlink to the target specified as the first parameter, at the
+  path specified by the second parameter. With option -r (EAPI 8),
+  an absolute path specified for the target will be converted to a path
+  relative to the link location.
+  
+  
+  Note: Without option -r, an absolute link target is interpreted
+  verbatim, i.e. it must include ${EPREFIX} when applicable.
+  
 
   
   



[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/

2023-05-27 Thread Ulrich Müller
commit: ada952e76ffe339d2e0a7b822a4786e26bb7fdfd
Author: Ulrich Müller  gentoo  org>
AuthorDate: Sat Apr 29 15:30:28 2023 +
Commit: Ulrich Müller  gentoo  org>
CommitDate: Sat May 27 18:50:34 2023 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=ada952e7

function-reference/install-functions: Reword dostrip documentation

As a followup to the previous change, use a better path for the
example and reword. No longer mention EAPI 7 because all older EAPIs
are deprecated.

Signed-off-by: Ulrich Müller  gentoo.org>

 function-reference/install-functions/text.xml | 10 +-
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/function-reference/install-functions/text.xml 
b/function-reference/install-functions/text.xml
index 6961784..0602c80 100644
--- a/function-reference/install-functions/text.xml
+++ b/function-reference/install-functions/text.xml
@@ -427,11 +427,11 @@ The *into functions create the directory if it 
does not already exist.
   dostrip
 
 
-  Introduced with EAPI=7, controls the stripping of executables.
-  Normally executed to exclude from stripping.
-  Eg. dostrip -x /path/to/important.so.  May also be used to 
include binaries
-  to strip when RESTRICT=strip without the -x option.
-  Provided paths are relative to ${ED}, even if they begin with a 
slash.
+  Controls stripping of executables. Normally used to exclude from
+  stripping, e.g. dostrip -x /usr/$(get_libdir)/important.so.
+  May also be used without the -x option to include binaries to
+  strip when RESTRICT=strip is set. Provided paths are relative
+  to ${ED}, even if they begin with a slash.
 
   
 



[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/

2023-04-29 Thread Ulrich Müller
commit: caa3e98b1431ceeead2924302bcc997d6214ba69
Author: matoro  users  noreply  github  com>
AuthorDate: Thu Apr 27 19:07:06 2023 +
Commit: Ulrich Müller  gentoo  org>
CommitDate: Sat Apr 29 15:26:18 2023 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=caa3e98b

function-reference/install-functions: add note about paths to dostrip

Found this extremely unintuitive especially compared to the
documentation on the `dosym` function which is much clearer.

Closes: https://bugs.gentoo.org/17
Signed-off-by: Matoro Mahri  users.noreply.github.com>
Signed-off-by: Ulrich Müller  gentoo.org>

 function-reference/install-functions/text.xml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/function-reference/install-functions/text.xml 
b/function-reference/install-functions/text.xml
index 9fbdcbe..6961784 100644
--- a/function-reference/install-functions/text.xml
+++ b/function-reference/install-functions/text.xml
@@ -431,6 +431,7 @@ The *into functions create the directory if it does 
not already exist.
   Normally executed to exclude from stripping.
   Eg. dostrip -x /path/to/important.so.  May also be used to 
include binaries
   to strip when RESTRICT=strip without the -x option.
+  Provided paths are relative to ${ED}, even if they begin with a 
slash.
 
   
 



[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/

2022-01-17 Thread Ulrich Müller
commit: 59830bf240718914323abcd7e77260e7a2858080
Author: Ulrich Müller  gentoo  org>
AuthorDate: Wed Dec 22 15:56:47 2021 +
Commit: Ulrich Müller  gentoo  org>
CommitDate: Mon Jan 17 16:52:09 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=59830bf2

function-reference/install-functions: be more specific about dobin location

Bug: https://bugs.gentoo.org/586632
Suggested-by: Sebastian Pipping  gentoo.org>
Signed-off-by: Ulrich Müller  gentoo.org>

 function-reference/install-functions/text.xml | 7 ---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/function-reference/install-functions/text.xml 
b/function-reference/install-functions/text.xml
index da2af83..fcb8941 100644
--- a/function-reference/install-functions/text.xml
+++ b/function-reference/install-functions/text.xml
@@ -103,9 +103,10 @@ The *into functions create the directory if it does 
not already exist.
   dobin
 
 
-  Install a binary into /usr/bin, set the file mode to 0755
-  and set the ownership to superuser or its equivalent on the
-  system or installation at hand.
+  Install a binary into subdirectory bin of the location provided
+  by into (resulting in /usr/bin by default) with mode 0755
+  and with ownership set to superuser or its equivalent on the system or
+  installation at hand
 
   
   



[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/

2020-02-24 Thread Ulrich Müller
commit: 054fc8a60b07ce387de5d2cf5467e937431d8183
Author: Ulrich Müller  gentoo  org>
AuthorDate: Thu Feb 20 19:17:03 2020 +
Commit: Ulrich Müller  gentoo  org>
CommitDate: Mon Feb 24 07:12:39 2020 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=054fc8a6

function-reference/install-functions: Explain that *into creates the dir.

Closes: https://bugs.gentoo.org/710318
Signed-off-by: Ulrich Müller  gentoo.org>

 function-reference/install-functions/text.xml | 4 
 1 file changed, 4 insertions(+)

diff --git a/function-reference/install-functions/text.xml 
b/function-reference/install-functions/text.xml
index 7e0b540..da2af83 100644
--- a/function-reference/install-functions/text.xml
+++ b/function-reference/install-functions/text.xml
@@ -15,6 +15,10 @@ targets. The new* functions take exactly two 
arguments (except as noted)
 the first is the source name, the second the name to use when installing.
 
 
+
+The *into functions create the directory if it does not already exist.
+
+
 
   
 



[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/, ebuild-writing/functions/src_prepare/, ...

2020-01-22 Thread Ulrich Müller
commit: 9e1a56d2ff7389708c55423037cb96570e4d52ed
Author: Ulrich Müller  gentoo  org>
AuthorDate: Mon Jan 20 16:32:43 2020 +
Commit: Ulrich Müller  gentoo  org>
CommitDate: Thu Jan 23 00:01:01 2020 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=9e1a56d2

ebuild-writing/eapi: Move EAPI=2 information to other sections.

- doman language support: incorporated into
  function-reference/install-functions
- Blockers incorporated into general-concepts/dependencies
  (also say "weak" and "strong" blockers instead of "soft" and "hard",
  in order to agree with the terms used in PMS)
- USE dependencies: already in general-concepts/dependencies
- SRC_URI arrows: incorporated into ebuild-writing/variables
- src_prepare: already in ebuild-writing/functions/src_prepare
- src_configure: already in ebuild-writing/functions/src_configure
- Execution order: already in ebuild-writing/functions
- Default phase functions moved to ebuild-writing/functions

Signed-off-by: Ulrich Müller  gentoo.org>

 ebuild-writing/eapi/text.xml   | 184 -
 ebuild-writing/functions/src_compile/text.xml  |  53 ++
 .../functions/src_prepare/epatch/text.xml  |  23 +--
 ebuild-writing/functions/src_prepare/text.xml  |  16 +-
 ebuild-writing/functions/src_unpack/text.xml   |  17 +-
 ebuild-writing/functions/text.xml  |  37 +
 ebuild-writing/variables/text.xml  |   5 +-
 function-reference/install-functions/text.xml  |  12 +-
 general-concepts/autotools/text.xml|  20 +--
 general-concepts/dependencies/text.xml |  40 +++--
 10 files changed, 113 insertions(+), 294 deletions(-)

diff --git a/ebuild-writing/eapi/text.xml b/ebuild-writing/eapi/text.xml
index f7427fd..048284f 100644
--- a/ebuild-writing/eapi/text.xml
+++ b/ebuild-writing/eapi/text.xml
@@ -62,190 +62,6 @@ is the best.  Using the features of the latest EAPI is 
encouraged.
 
 
 
-
-EAPI=2
-
-
-EAPI 2 Helpers
-
-
-   
-   doman Language Support
-   
-   doman automatically detects language codes and puts it 
in the
-   appropriate directory.
-   
-
-doman foo.1
-# will go into /usr/share/man/man1/foo.1
-doman foo.lang.1
-# will go into /usr/share/man/lang/man1/foo.1 with EAPI=2
-
-   
-
-
-
-
-
-EAPI 2 Metadata
-
-
-   
-   Blockers
-   
-   
-   New Meaning for Old Syntax
-   
-   Blockers which use the previously existing 
! syntax
-   now have a slightly different meaning. These 
so-called
-   weak blocks indicate that conflicting 
packages may
-   be temporarily installed simultaneously. When 
temporary
-   simultaneous installation of conflicting 
packages occurs, the
-   installation of a newer package may overwrite 
any colliding
-   files that belong to an older package which is 
explicitly
-   blocked. When such file collisions occur, the 
colliding files
-   cease to belong to the older package, and they 
remain installed
-   after the older package is eventually 
uninstalled. The older
-   package is uninstalled only after any newer 
blocking packages
-   have been merged on top of it.
-   
-   
-   
-   New !! Operator
-   
-   A new !! operator for strong 
blocks is now
-   supported, for use in special cases for which 
temporary
-   simultaneous installation of conflicting 
packages should not be
-   allowed. If both weak and strong blocks match a 
given package,
-   the strong block takes precedence.
-   
-   
-   
-   
-   
-   USE Dependencies
-   
-   It is possible to depend on USE-flags of packages.
-   
-   Examples:
-   
-   foo[bar] means that package foo must have 
USE-flag bar
-   enabled
-   foo[bar,baz] means that the package foo must 
have both
-   the bar and baz USE-flags enabled
-   
-   foo[-bar,baz] means that the package foo 
must have the
-   bar USE-flag disabled and baz USE-flag 
enabled
-   foo[bar?] means bar? ( foo[bar] ) 

[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/

2019-11-22 Thread Michael Orlitzky
commit: 401ad3ebcf88837618fa559c5cea7666a4b30435
Author: Michael Orlitzky  gentoo  org>
AuthorDate: Thu Apr 25 00:39:30 2019 +
Commit: Michael Orlitzky  gentoo  org>
CommitDate: Fri Nov 22 13:31:16 2019 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=401ad3eb

function-reference/install-functions: clarify dodir/keepdir usage.

The existing "Install Functions Reference" documentation on dodir()
and keepdir() is a bit wishy-washy. What developers really want to
know is, when do I use one, and when do I use the other?

This commit updates the descriptions of those two functions to provide
that information. If the directory will be non-empty, dodir() is fine.
Otherwise, keepdir() should be used. Some rationale for the existence
of the keepdir() function is also provided for the skeptical developer
who might otherwise find it superfluous.

This change mirrors an update to the ebuild(5) man page in portage.

Closes: https://bugs.gentoo.org/451472
Reported-by: Matthew Schultz  gmail.com>
Signed-off-by: Michael Orlitzky  gentoo.org>

 function-reference/install-functions/text.xml | 16 
 1 file changed, 12 insertions(+), 4 deletions(-)

diff --git a/function-reference/install-functions/text.xml 
b/function-reference/install-functions/text.xml
index 2b0cbf2..06bc241 100644
--- a/function-reference/install-functions/text.xml
+++ b/function-reference/install-functions/text.xml
@@ -117,7 +117,9 @@ the first is the source name, the second the name to use 
when installing.
   dodir
 
 
-  Install a directory
+  Install a directory that will be non-empty when the package is
+  merged. For directories that will be empty, please use
+  keepdir instead.
 
   
   
@@ -288,9 +290,15 @@ the first is the source name, the second the name to use 
when installing.
   keepdir
 
 
-  Create a directory which will be preserved by the package
-  manager (This is typically accomplished by inserting an empty
-  .keep_${CATEGORY}_${PN}-${SLOT%/*} file in the directory)
+  Install a directory that will be empty when the package is
+  merged. This is like dodir, but for empty directories
+  instead. https://projects.gentoo.org/pms/7/pms.html#x1-14200013.2.2;>The
+  handling of empty directories is undefined by the package
+  manager specification, and the keepdir function
+  exists to ensure that the (otherwise empty) directory is
+  tracked. This is accomplished by installing a hidden file
+  prefixed with .keep to the directory in question.
 
   
   



[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/, ebuild-writing/variables/, ...

2018-10-24 Thread Brian Evans
commit: 48b054eb8da9f4689480249e6d65076953dc0ed5
Author: Brian Evans  gentoo  org>
AuthorDate: Wed Oct 24 16:50:22 2018 +
Commit: Brian Evans  gentoo  org>
CommitDate: Wed Oct 24 16:50:22 2018 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=48b054eb

Tidy up formatting, links and typo for BDEPEND

Signed-off-by: Brian Evans  gentoo.org>

 ebuild-writing/eapi/text.xml | 4 ++--
 ebuild-writing/functions/src_prepare/epatch/text.xml | 6 +++---
 ebuild-writing/variables/text.xml| 2 +-
 function-reference/install-functions/text.xml| 4 ++--
 4 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/ebuild-writing/eapi/text.xml b/ebuild-writing/eapi/text.xml
index 1eb82b9..fabbc93 100644
--- a/ebuild-writing/eapi/text.xml
+++ b/ebuild-writing/eapi/text.xml
@@ -1054,7 +1054,7 @@ src_install() {
Empty groupings are banned
Groupings which are empty, such as DEPEND="|| ( 
${empty_var} )" will now generate an error.
Furthermore, conditions within groupings are more strictly 
enforced.
-   Eg. REQUIRED_USE="|| ( foo? ( bar ) baz? ( zoinks )" 
would previously work with USE="-a -b" now requires
+   Eg. REQUIRED_USE="|| ( foo? ( bar ) baz? ( zoinks )" 
would previously work with USE="-foo -baz" now requires
either USE="foo bar" or USE="baz zoinks".


@@ -1110,7 +1110,7 @@ src_install() {
ver_rs replaces separators in a version 
string
ver_test compares two versions

-   See 
+   See Version 
and Name Formatting Issues
for examples of common uses or
https://dev.gentoo.org/~mgorny/articles/the-ultimate-guide-to-eapi-7.html#version-manipulation-and-comparison-commands;>
an in-depth look

diff --git a/ebuild-writing/functions/src_prepare/epatch/text.xml 
b/ebuild-writing/functions/src_prepare/epatch/text.xml
index 720fd67..5a6939d 100644
--- a/ebuild-writing/functions/src_prepare/epatch/text.xml
+++ b/ebuild-writing/functions/src_prepare/epatch/text.xml
@@ -14,15 +14,15 @@ Also note that old ebuilds may still use src_unpack to 
apply patches.
 This is because those ebuilds are based in EAPI=1.
 You are advised to use the latest and apply your patches in src_prepare 
function instead.
 
-Starting with EAPI=7, this function is banned and eapply must be used.
+Starting with EAPI=7, this function is banned and eapply must be used.
 
 
 
-Beginning with EAPI=6, a new function eapply was added to apply patches
+Beginning with EAPI=6, a new function eapply was added to apply patches
 without the need for an eclass.
 This function differs from epatch in several ways:
 
-eapply will not unpack patches for you.
+eapply will not unpack patches for you.
 
 The default patch level is -p1.
 Other patch levels must be specified manually or the command will fail.

diff --git a/ebuild-writing/variables/text.xml 
b/ebuild-writing/variables/text.xml
index fa960ee..f2575ad 100644
--- a/ebuild-writing/variables/text.xml
+++ b/ebuild-writing/variables/text.xml
@@ -257,7 +257,7 @@ The following variables may or must be defined by every 
ebuild.
 
   
   
-DEPEND
+BDEPEND
 
 (EAPI=7) A list of the package's CBUILD build dependencies.  See
 .

diff --git a/function-reference/install-functions/text.xml 
b/function-reference/install-functions/text.xml
index d0c8833..2b0cbf2 100644
--- a/function-reference/install-functions/text.xml
+++ b/function-reference/install-functions/text.xml
@@ -88,10 +88,10 @@ the first is the source name, the second the name to use 
when installing.
   
 
   libopts
-  Note: Banned in EAPI=7
 
 
   Specify arguments passed to install for libraries
+  Note: Banned in EAPI=7
 
   
   
@@ -208,10 +208,10 @@ the first is the source name, the second the name to use 
when installing.
   
 
   dolib
-  Note: Banned in EAPI=7
 
 
   Install a library file
+  Note: Banned in EAPI=7
 
   
   



[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/, ebuild-writing/functions/src_prepare/, ...

2018-10-24 Thread Brian Evans
commit: ffa353428d17602c069d4cd2206a698497cc4c33
Author: Brian Evans  gentoo  org>
AuthorDate: Wed Oct 24 14:46:49 2018 +
Commit: Brian Evans  gentoo  org>
CommitDate: Wed Oct 24 14:46:49 2018 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=ffa35342

More XML syntax fixes

Signed-off-by: Brian Evans  gentoo.org>

 ebuild-writing/eapi/text.xml  | 8 
 ebuild-writing/functions/src_prepare/text.xml | 4 ++--
 function-reference/install-functions/text.xml | 2 +-
 3 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/ebuild-writing/eapi/text.xml b/ebuild-writing/eapi/text.xml
index 8653b20..1eb82b9 100644
--- a/ebuild-writing/eapi/text.xml
+++ b/ebuild-writing/eapi/text.xml
@@ -1054,7 +1054,7 @@ src_install() {
Empty groupings are banned
Groupings which are empty, such as DEPEND="|| ( 
${empty_var} )" will now generate an error.
Furthermore, conditions within groupings are more strictly 
enforced.
-   Eg. REQUIRED_USE="|| ( foo? ( bar ) baz? ( zoinks )" 
would previously work with USE="-a -b" now requires
+   Eg. REQUIRED_USE="|| ( foo? ( bar ) baz? ( zoinks )" 
would previously work with USE="-a -b" now requires
either USE="foo bar" or USE="baz zoinks".


@@ -1066,7 +1066,7 @@ src_install() {
 
 

-   package.provided banned
+   package.provided banned
Profiles may no longer contain a package.provided 
file with EAPI=7.

 
@@ -1127,8 +1127,8 @@ src_install() {
New function dostrip

The dostrip helper has been added with 
EAPI=7.
-   This function controls whether or not to strip a 
binary.
-   dostrip -x [file] will exclude a binary from 
being stripped.
+   This function controls whether or not to strip a 
binary.
+   dostrip -x [file] will exclude a binary from 
being stripped.
Conversely, when combined with RESTRICT=strip, 
dostrip [file] selects a binary
file to be stripped.


diff --git a/ebuild-writing/functions/src_prepare/text.xml 
b/ebuild-writing/functions/src_prepare/text.xml
index 214dfbf..0425bb1 100644
--- a/ebuild-writing/functions/src_prepare/text.xml
+++ b/ebuild-writing/functions/src_prepare/text.xml
@@ -46,9 +46,9 @@ Beginning with EAPI=6, the src_prepare function gained a new 
default implementat
 
 src_prepare() {
 if declare -p PATCHES | grep -q "^declare -a "; then
-[[ -n ${PATCHES[@]} ]] && eapply "${PATCHES[@]}"
+[[ -n ${PATCHES[@]} ]]  eapply "${PATCHES[@]}"
 else
-[[ -n ${PATCHES} ]] && eapply ${PATCHES}
+[[ -n ${PATCHES} ]]  eapply ${PATCHES}
 fi
 eapply_user
 }

diff --git a/function-reference/install-functions/text.xml 
b/function-reference/install-functions/text.xml
index e42b4f6..d0c8833 100644
--- a/function-reference/install-functions/text.xml
+++ b/function-reference/install-functions/text.xml
@@ -243,7 +243,7 @@ the first is the source name, the second the name to use 
when installing.
   domo
 
 
-  Install a Gettext .mo file
+  Install a Gettext .mo file
   (EAPI=7) No longer looks at the value of into
 
   



[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/

2018-10-24 Thread Brian Evans
commit: 7cb1e1f8abbf1db100e3685cd9d1093c2a788a03
Author: Brian Evans  gentoo  org>
AuthorDate: Mon Sep 17 15:13:36 2018 +
Commit: Brian Evans  gentoo  org>
CommitDate: Wed Oct 24 12:56:37 2018 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=7cb1e1f8

install-functions: Update domo and add dostrip for EAPI=7

Signed-off-by: Brian Evans  gentoo.org>

 function-reference/install-functions/text.xml | 14 +-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/function-reference/install-functions/text.xml 
b/function-reference/install-functions/text.xml
index 1134164..24552a7 100644
--- a/function-reference/install-functions/text.xml
+++ b/function-reference/install-functions/text.xml
@@ -242,7 +242,8 @@ the first is the source name, the second the name to use 
when installing.
   domo
 
 
-  Install a Gettext .mo file
+  Install a Gettext .mo file
+  (EAPI=7) No longer looks at the value of into
 
   
   
@@ -387,6 +388,17 @@ the first is the source name, the second the name to use 
when installing.
   Install an sbin file using the second argument as the name
 
   
+  
+
+  dostrip
+
+
+  Introduced with EAPI=7, controls the stripping of executables.
+  Normally executed to exclude from stripping.
+  Eg. dostrip -x /path/to/important.so.  May also be used to 
include binaries
+  to strip when RESTRICT=strip without the -x option.
+
+  
 
 
 



[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/

2018-10-24 Thread Brian Evans
commit: e9a60c0e885eb466dd3251ee33ab309f592ecd1d
Author: Brian Evans  gentoo  org>
AuthorDate: Mon Sep 17 15:20:59 2018 +
Commit: Brian Evans  gentoo  org>
CommitDate: Wed Oct 24 12:56:37 2018 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=e9a60c0e

install-functions: mark dohtml as banned with EAPI=7

Signed-off-by: Brian Evans  gentoo.org>

 function-reference/install-functions/text.xml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/function-reference/install-functions/text.xml 
b/function-reference/install-functions/text.xml
index 24552a7..e42b4f6 100644
--- a/function-reference/install-functions/text.xml
+++ b/function-reference/install-functions/text.xml
@@ -176,7 +176,8 @@ the first is the source name, the second the name to use 
when installing.
   Installs HTML document files into /usr/share/doc/${PF}/html
   The -r option allows directories to be installed recursively.
   Note: Deprecated in EAPI 6, switch to einstalldocs
-  instead
+  instead.
+  Note: Banned in EAPI=7
 
   
   



[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/

2018-08-01 Thread Göktürk Yüksek
commit: 5334a50837431d67a196a7848623e01401b3c5eb
Author: Mike Gilbert  gentoo  org>
AuthorDate: Thu Jul 26 17:23:11 2018 +
Commit: Göktürk Yüksek  gentoo  org>
CommitDate: Wed Aug  1 22:57:52 2018 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=5334a508

install-functions: refer to ${ED} instead of ${D}

Since EAPI 3, the install functions use ${ED} instead of ${D}.

 function-reference/install-functions/text.xml | 9 -
 1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/function-reference/install-functions/text.xml 
b/function-reference/install-functions/text.xml
index b6bd181..1134164 100644
--- a/function-reference/install-functions/text.xml
+++ b/function-reference/install-functions/text.xml
@@ -5,9 +5,8 @@
 
 
 
-The following functions, which are all provided by ebuild.sh and the 
standard
-library, handle various install-related tasks. ${D} is automatically 
handled
-for all of these functions.
+The following functions are provided by the package manager to handle various
+install-related tasks. ${ED} is prepended automatically to the install 
location.
 
 
 
@@ -271,7 +270,7 @@ the first is the source name, the second the name to use 
when installing.
   fowners
 
 
-  Call chown on the specified files in ${D}
+  Call chown on the specified files in ${ED}
 
   
   
@@ -279,7 +278,7 @@ the first is the source name, the second the name to use 
when installing.
   fperms
 
 
-  Call chmod on the specified files in ${D}
+  Call chmod on the specified files in ${ED}
 
   
   



[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/

2018-06-22 Thread Ulrich Müller
commit: 97aea4d9a36ee06d82e64de9ce415741b41483d8
Author: Mikle Kolyada  gentoo  org>
AuthorDate: Sat Jun 16 21:25:20 2018 +
Commit: Ulrich Müller  gentoo  org>
CommitDate: Fri Jun 22 18:23:59 2018 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=97aea4d9

function-reference/install-functions: add ban notes about libopts and dolib

 function-reference/install-functions/text.xml | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/function-reference/install-functions/text.xml 
b/function-reference/install-functions/text.xml
index c1392bf..b6bd181 100644
--- a/function-reference/install-functions/text.xml
+++ b/function-reference/install-functions/text.xml
@@ -89,6 +89,7 @@ the first is the source name, the second the name to use when 
installing.
   
 
   libopts
+  Note: Banned in EAPI=7
 
 
   Specify arguments passed to install for libraries
@@ -207,6 +208,7 @@ the first is the source name, the second the name to use 
when installing.
   
 
   dolib
+  Note: Banned in EAPI=7
 
 
   Install a library file



[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/

2017-08-28 Thread Göktürk Yüksek
commit: dd8078107236415fd8c5ea461f0119dd1e285a4c
Author: Michał Górny  gentoo  org>
AuthorDate: Sat Aug 26 17:08:23 2017 +
Commit: Göktürk Yüksek  gentoo  org>
CommitDate: Mon Aug 28 20:00:20 2017 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=dd807810

install-functions: Verbosely explain dosym target parameter

It is a common misconception that dosym takes two paths, both of them
interpreted relatively to ${ED}. To avoid that, explicitly explain
that the first parameter is interpreted as a verbatim symlink target.

 function-reference/install-functions/text.xml | 6 +-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/function-reference/install-functions/text.xml 
b/function-reference/install-functions/text.xml
index 6523521..c1392bf 100644
--- a/function-reference/install-functions/text.xml
+++ b/function-reference/install-functions/text.xml
@@ -257,7 +257,11 @@ the first is the source name, the second the name to use 
when installing.
   dosym
 
 
-  Create a symlink from the second parameter to the first parameter
+  Create a symlink to the target specified as the first parameter,
+  at the path specified by the second parameter. Note that
+  the target is interpreted verbatim; it needs to either
+  specify a relative path or an absolute path including
+  ${EPREFIX}.
 
   
   



[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/

2017-06-21 Thread Göktürk Yüksek
commit: 505c8f3c2d4d35156aea7d4c615188f258176885
Author: Moritz Schlarb  metalabs  de>
AuthorDate: Sat Jun 10 06:53:39 2017 +
Commit: Göktürk Yüksek  gentoo  org>
CommitDate: Wed Jun 21 17:24:18 2017 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=505c8f3c

function-reference/install-functions: mention the recursive option for helpers

Mention recursive installing for `doins` et. al.

Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=384941

 function-reference/install-functions/text.xml | 7 +--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/function-reference/install-functions/text.xml 
b/function-reference/install-functions/text.xml
index 415fbd7..6523521 100644
--- a/function-reference/install-functions/text.xml
+++ b/function-reference/install-functions/text.xml
@@ -164,7 +164,8 @@ the first is the source name, the second the name to use 
when installing.
   doheader
 
 
-  Install a header file into /usr/include
+  Install a header file into /usr/include.
+  The -r option allows directories to be installed recursively.
 
   
   
@@ -173,6 +174,7 @@ the first is the source name, the second the name to use 
when installing.
 
 
   Installs HTML document files into /usr/share/doc/${PF}/html
+  The -r option allows directories to be installed recursively.
   Note: Deprecated in EAPI 6, switch to einstalldocs
   instead
 
@@ -198,7 +200,8 @@ the first is the source name, the second the name to use 
when installing.
   doins
 
 
-  Install a miscellaneous file
+  Install a miscellaneous file.
+  The -r option allows directories to be installed recursively.
 
   
   



[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/

2016-12-08 Thread Göktürk Yüksek
commit: 0c32c62a1a251a902461ac9c5bc7bed0d8ef2c6a
Author: Göktürk Yüksek  gentoo  org>
AuthorDate: Thu Dec  8 16:45:15 2016 +
Commit: Göktürk Yüksek  gentoo  org>
CommitDate: Thu Dec  8 16:46:22 2016 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=0c32c62a

function-reference/install-functions: suggest einstalldocs over dohtml #591476

 function-reference/install-functions/text.xml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/function-reference/install-functions/text.xml 
b/function-reference/install-functions/text.xml
index 9ef0d95..415fbd7 100644
--- a/function-reference/install-functions/text.xml
+++ b/function-reference/install-functions/text.xml
@@ -173,7 +173,8 @@ the first is the source name, the second the name to use 
when installing.
 
 
   Installs HTML document files into /usr/share/doc/${PF}/html
-  Note: Deprecated in EAPI 6.
+  Note: Deprecated in EAPI 6, switch to einstalldocs
+  instead
 
   
   



[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/

2016-12-07 Thread Göktürk Yüksek
commit: 318842a1c2cb45242cbe8d6d56683ee22f5da2ad
Author: Göktürk Yüksek  gentoo  org>
AuthorDate: Wed Dec  7 19:21:25 2016 +
Commit: Göktürk Yüksek  gentoo  org>
CommitDate: Wed Dec  7 19:24:12 2016 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=318842a1

function-reference/install-functions: document dodoc -r

 function-reference/install-functions/text.xml | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/function-reference/install-functions/text.xml 
b/function-reference/install-functions/text.xml
index 614a8df..e2337c1 100644
--- a/function-reference/install-functions/text.xml
+++ b/function-reference/install-functions/text.xml
@@ -125,7 +125,9 @@ the first is the source name, the second the name to use 
when installing.
   dodoc
 
 
-  Install a documentation file into /usr/share/doc/${PF}
+  Install a documentation file into /usr/share/doc/${PF}.
+  For EAPI 4 and above, the -r option allows directories to
+  be installed recursively.
 
   
   



[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/

2016-12-07 Thread Göktürk Yüksek
commit: 1a48702c2fee32c801dfba3176f89d599c7336de
Author: Wim Muskee  gmail  com>
AuthorDate: Wed Dec  7 19:38:18 2016 +
Commit: Göktürk Yüksek  gentoo  org>
CommitDate: Wed Dec  7 19:38:18 2016 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=1a48702c

function-reference/install-function: document einstalldocs

 function-reference/install-functions/text.xml | 11 +++
 1 file changed, 11 insertions(+)

diff --git a/function-reference/install-functions/text.xml 
b/function-reference/install-functions/text.xml
index e2337c1..9ef0d95 100644
--- a/function-reference/install-functions/text.xml
+++ b/function-reference/install-functions/text.xml
@@ -132,6 +132,17 @@ the first is the source name, the second the name to use 
when installing.
   
   
 
+  einstalldocs
+
+
+  Installs the files and directories specified by the DOCS
+  and HTML_DOCS variables into /usr/share/doc/${PF}
+  recursively using dodoc -r. Note: Approved in EAPI
+  6.
+
+  
+  
+
   doenvd
 
 



[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/

2016-11-29 Thread Göktürk Yüksek
commit: 7aaea52be77d25a4adad322627d79e1d699330b5
Author: Wim Muskee  gmail  com>
AuthorDate: Thu Nov 17 19:46:35 2016 +
Commit: Göktürk Yüksek  gentoo  org>
CommitDate: Wed Nov 30 05:25:12 2016 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=7aaea52b

function-reference/install-functions: differentiate doexe and dobin better

Gentoo-Bug: 586632

 function-reference/install-functions/text.xml | 8 ++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/function-reference/install-functions/text.xml 
b/function-reference/install-functions/text.xml
index fec68ba..614a8df 100644
--- a/function-reference/install-functions/text.xml
+++ b/function-reference/install-functions/text.xml
@@ -99,7 +99,9 @@ the first is the source name, the second the name to use when 
installing.
   dobin
 
 
-  Install a binary
+  Install a binary into /usr/bin, set the file mode to 0755
+  and set the ownership to superuser or its equivalent on the
+  system or installation at hand.
 
   
   
@@ -139,7 +141,9 @@ the first is the source name, the second the name to use 
when installing.
   doexe
 
 
-  Install an executable
+  Install an executable into the location provided by exeinto,
+  by default with mode 0755 or with the install options set by
+  exeopts
 
   
   



[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/

2016-10-04 Thread Göktürk Yüksek
commit: 7535ebe6282c0b66c4aaa716917c67c151a07f3c
Author: Manuel Rüger  rueg  eu>
AuthorDate: Mon Sep 26 17:01:45 2016 +
Commit: Göktürk Yüksek  gentoo  org>
CommitDate: Tue Oct  4 11:58:17 2016 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=7535ebe6

Update keepdir description

Provide a better description for the .keep file

 function-reference/install-functions/text.xml | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/function-reference/install-functions/text.xml 
b/function-reference/install-functions/text.xml
index fcc827d..2d13749 100644
--- a/function-reference/install-functions/text.xml
+++ b/function-reference/install-functions/text.xml
@@ -267,7 +267,9 @@ the first is the source name, the second the name to use 
when installing.
   keepdir
 
 
-  Create a directory with an empty .keep file in it
+  Create a directory which will be preserved by the package
+  manager (This is typically accomplished by inserting an empty
+  .keep_${CATEGORY}_${PN}-${SLOT%/*} file in the directory)
 
   
   



[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/

2016-10-03 Thread Ulrich Müller
commit: 72d04a446170e7ccb05521920dbfc4eea49fd533
Author: Ulrich Müller  gentoo  org>
AuthorDate: Mon Oct  3 14:50:19 2016 +
Commit: Ulrich Müller  gentoo  org>
CommitDate: Mon Oct  3 14:50:19 2016 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=72d04a44

function-reference/install-functions: Add newheader.

Bug: 596038

 function-reference/install-functions/text.xml | 8 
 1 file changed, 8 insertions(+)

diff --git a/function-reference/install-functions/text.xml 
b/function-reference/install-functions/text.xml
index 3e96f2b..fcc827d 100644
--- a/function-reference/install-functions/text.xml
+++ b/function-reference/install-functions/text.xml
@@ -312,6 +312,14 @@ the first is the source name, the second the name to use 
when installing.
   
   
 
+  newheader
+
+
+  Install a header file using the second argument as the name
+
+  
+  
+
   newinitd
 
 



[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/

2016-10-03 Thread Ulrich Müller
commit: 2cd81375a441aaa28555aa5c7b09864e8863c669
Author: Ulrich Müller  gentoo  org>
AuthorDate: Mon Oct  3 14:48:19 2016 +
Commit: Ulrich Müller  gentoo  org>
CommitDate: Mon Oct  3 14:48:19 2016 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=2cd81375

function-reference/install-functions: Remove trailing full stops in table.

According to style guide:
https://sources.gentoo.org/cgi-bin/viewvc.cgi/gentoo/xml/htdocs/doc/en/xml-guide.xml?revision=1.72=markup#l1159

 function-reference/install-functions/text.xml | 26 +-
 1 file changed, 13 insertions(+), 13 deletions(-)

diff --git a/function-reference/install-functions/text.xml 
b/function-reference/install-functions/text.xml
index 1d18b24..3e96f2b 100644
--- a/function-reference/install-functions/text.xml
+++ b/function-reference/install-functions/text.xml
@@ -67,7 +67,7 @@ the first is the source name, the second the name to use when 
installing.
   insopts
 
 
-  Specify arguments passed to install (eg -s, -m644).
+  Specify arguments passed to install (eg -s, -m644)
 
   
   
@@ -267,7 +267,7 @@ the first is the source name, the second the name to use 
when installing.
   keepdir
 
 
-  Create a directory with an empty .keep file in it.
+  Create a directory with an empty .keep file in it
 
   
   
@@ -275,7 +275,7 @@ the first is the source name, the second the name to use 
when installing.
   newbin
 
 
-  Install a binary using the second argument as the name.
+  Install a binary using the second argument as the name
 
   
   
@@ -283,7 +283,7 @@ the first is the source name, the second the name to use 
when installing.
   newconfd
 
 
-  Install an /etc/conf.d entry using the second argument as the 
name.
+  Install an /etc/conf.d entry using the second argument as the name
 
   
   
@@ -291,7 +291,7 @@ the first is the source name, the second the name to use 
when installing.
   newdoc
 
 
-  Install a documentation file using the second argument as the name.
+  Install a documentation file using the second argument as the name
 
   
   
@@ -299,7 +299,7 @@ the first is the source name, the second the name to use 
when installing.
   newenvd
 
 
-  Install an /etc/env.d file using the second argument as the name.
+  Install an /etc/env.d file using the second argument as the name
 
   
   
@@ -307,7 +307,7 @@ the first is the source name, the second the name to use 
when installing.
   newexe
 
 
-  Install an executable file using the second argument as the name.
+  Install an executable file using the second argument as the name
 
   
   
@@ -315,7 +315,7 @@ the first is the source name, the second the name to use 
when installing.
   newinitd
 
 
-  Install an /etc/init.d file using the second argument as the name.
+  Install an /etc/init.d file using the second argument as the name
 
   
   
@@ -323,7 +323,7 @@ the first is the source name, the second the name to use 
when installing.
   newins
 
 
-  Install a miscellaneous file using the second argument as the name.
+  Install a miscellaneous file using the second argument as the name
 
   
   
@@ -331,7 +331,7 @@ the first is the source name, the second the name to use 
when installing.
   newlib.a
 
 
-  Install a .a library file using the second argument as the name.
+  Install a .a library file using the second argument as the name
 
   
   
@@ -339,7 +339,7 @@ the first is the source name, the second the name to use 
when installing.
   newlib.so
 
 
-  Install a .so library file using the second argument as the name.
+  Install a .so library file using the second argument as the name
 
   
   
@@ -347,7 +347,7 @@ the first is the source name, the second the name to use 
when installing.
   newman
 
 
-  Install a manual page using the second argument as the name.
+  Install a manual page using the second argument as the name
 
   
   
@@ -355,7 +355,7 @@ the first is the source name, the second the name to use 
when installing.
   newsbin
 
 
-  Install an sbin file using the second argument as the name.
+  Install an sbin file using the second argument as the name
 
   
 



[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/

2016-10-03 Thread Mike Gilbert
commit: 38a0a3642a40300af4a16199a5acd2bfee7f49c4
Author: Mike Gilbert  gentoo  org>
AuthorDate: Mon Oct  3 13:37:55 2016 +
Commit: Mike Gilbert  gentoo  org>
CommitDate: Mon Oct  3 13:44:50 2016 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=38a0a364

install-functions: Fix the description of 'into'

Thanks to ulm for the corrected list of functions.

Bug: https://bugs.gentoo.org/596032

 function-reference/install-functions/text.xml | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/function-reference/install-functions/text.xml 
b/function-reference/install-functions/text.xml
index 66a8629..1d18b24 100644
--- a/function-reference/install-functions/text.xml
+++ b/function-reference/install-functions/text.xml
@@ -33,9 +33,9 @@ the first is the source name, the second the name to use when 
installing.
   Change install location for
   dobin, newbin,
   dosbin, newsbin,
-  doman, newman,
-  doinfo, newinfo,
-  dolib, newlib
+  dolib,
+  dolib.a, newlib.a,
+  dolib.so, newlib.so
 
   
   



[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/

2016-08-17 Thread Göktürk Yüksek
commit: c3252db78941acb0a2b9a481e8d9e58e7a41dea8
Author: Wim Muskee  gmail  com>
AuthorDate: Wed Aug 17 05:17:34 2016 +
Commit: Göktürk Yüksek  gentoo  org>
CommitDate: Thu Aug 18 03:24:44 2016 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=c3252db7

function-reference/install-functions: add doheader and update dodoc

Add doheader and add install location to dodoc.

Minor edits by the committer to use a singular form of 'header files'
to be consistent with the rest of the section.

 function-reference/install-functions/text.xml | 10 +-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/function-reference/install-functions/text.xml 
b/function-reference/install-functions/text.xml
index 1feb198..66a8629 100644
--- a/function-reference/install-functions/text.xml
+++ b/function-reference/install-functions/text.xml
@@ -123,7 +123,7 @@ the first is the source name, the second the name to use 
when installing.
   dodoc
 
 
-  Install a documentation file
+  Install a documentation file into /usr/share/doc/${PF}
 
   
   
@@ -152,6 +152,14 @@ the first is the source name, the second the name to use 
when installing.
   
   
 
+  doheader
+
+
+  Install a header file into /usr/include
+
+  
+  
+
   dohtml