9ac08e2 Improve documentation by documenting the upgrade phase — HardenedBSD-pkg

rad:z3QDZAW2FAfuLvihrhiyDC9fAD8G9

HardenedBSD Package Manager

Improve documentation by documenting the upgrade phase

Baptiste Daroussin committed 6 years ago

commit 9ac08e2e590213b857380a4d42b4111552b7273a
parent e7780c1

2 files changed +26 -0

modified docs/pkg-lua-script.5

@@ -39,6 +39,20 @@ run after removing the files on the system.

 .Pp
 A package can contain multiple scripts per phase, they will all be run inside
 their own lua VM.
 .Pp
 In the particular case of an upgrade the scripts are run in the following order:
 .Bl -enum -compact
 .It
 new pre-install
 .It
 old pre-deinstall
 .It
 replace binaries
 .It
 new post-install
 .El
 .Pp
 Lua scripts are always run after shell scripts (of the same phase).
 .Sh API
 All the regular lua API are available to the exception of the following changes:
 .Bl -tag -width Ds

modified docs/pkg-script.5

@@ -33,6 +33,18 @@ run before removing the files on the system.

 .It Cm post-deinstall :
 run after removing the files on the system.
 .El
 .Pp
 In the particular case of an upgrade the scripts are run in the following order:
 .Bl -enum -compact
 .It
 new pre-install
 .It
 old pre-deinstall
 .It
 replace binaries
 .It
 new post-install
 .El
 .Sh Environment
 The following environment variable are exported to be used by the script
 .Bl -tag -width Ds