Skip to content

Commit 531f1f0

Browse files
aiutoaiuto
committed
update docs
1 parent 91dee48 commit 531f1f0

File tree

1 file changed

+74
-74
lines changed

1 file changed

+74
-74
lines changed

‎docs/latest.md‎

Lines changed: 74 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -436,80 +436,6 @@ pkg_zip(<a href="#pkg_zip-name">name</a>, <a href="#pkg_zip-srcs">srcs</a>, <a h
436436

437437

438438

439-
<!-- Generated with Stardoc: http://skydoc.bazel.build -->
440-
441-
Rules for creating install scripts from pkg_filegroups and friends.
442-
443-
This module provides an interface (`pkg_install`) for creating a `bazel
444-
run`-able installation script.
445-
446-
<a id="pkg_install"></a>
447-
448-
## pkg_install
449-
450-
<pre>
451-
load("@rules_pkg//pkg:install.bzl", "pkg_install")
452-
453-
pkg_install(<a href="#pkg_install-name">name</a>, <a href="#pkg_install-srcs">srcs</a>, <a href="#pkg_install-destdir">destdir</a>, <a href="#pkg_install-destdir_flag">destdir_flag</a>, <a href="#pkg_install-kwargs">**kwargs</a>)
454-
</pre>
455-
456-
Create an installer script from pkg_filegroups and friends.
457-
458-
This macro allows users to create `bazel run`nable installation scripts
459-
using the pkg_filegroup framework.
460-
461-
For example:
462-
463-
```python
464-
pkg_install(
465-
name = "install",
466-
srcs = [
467-
# mapping/grouping targets here
468-
],
469-
destdir = "out/install",
470-
)
471-
```
472-
473-
Installation can be done by invoking:
474-
475-
```
476-
bazel run -- //path/to:install
477-
```
478-
479-
Additional features can be accessed by invoking the script with the --help
480-
option:
481-
482-
```
483-
bazel run -- //path/to:install --help
484-
```
485-
486-
WARNING: While this rule does function when being run from within a bazel
487-
rule, such use is not recommended. If you do, **always** use the
488-
`--destdir` argument to specify the desired location for the installation to
489-
occur. Not doing so can lead the outputs going to an unexpected location,
490-
or in some cases, failing. Run the script command with `--help`, as
491-
mentioned above, for more details.
492-
493-
One such use would be to run the script created by `pkg_install` to produce
494-
a directory output in the build root. This may not function as expected or
495-
may suffer from poorly tested edge cases. A purpose-written rule that would
496-
allow for creation of such directories is discussed in
497-
https://github.com/bazelbuild/rules_pkg/issues/388.
498-
499-
500-
**PARAMETERS**
501-
502-
503-
| Name | Description | Default Value |
504-
| :------------- | :------------- | :------------- |
505-
| <a id="pkg_install-name"></a>name | rule name | none |
506-
| <a id="pkg_install-srcs"></a>srcs | pkg_filegroup framework mapping or grouping targets | none |
507-
| <a id="pkg_install-destdir"></a>destdir | The default destination directory.<br><br>If it is specified, this is the default destination to install the files. It is overridable by explicitly specifying `--destdir` in the command line or specifying the `DESTDIR` environment variable.<br><br>If it is not specified, `--destdir` must be set on the command line, or the `DESTDIR` environment variable must be set.<br><br>If this is an absolute path, it is used as-is. If this is a relative path, it is interpreted against `BUILD_WORKSPACE_DIRECTORY`. | `None` |
508-
| <a id="pkg_install-destdir_flag"></a>destdir_flag | A string_flag target used to obtain the value of destdir. | `None` |
509-
| <a id="pkg_install-kwargs"></a>kwargs | common rule attributes | none |
510-
511-
512-
513439
<!-- Generated with Stardoc: http://skydoc.bazel.build -->
514440

515441
Package creation helper mapping rules.
@@ -831,6 +757,80 @@ strip_prefix.from_root(<a href="#strip_prefix.from_root-path">path</a>)
831757

832758

833759

760+
<!-- Generated with Stardoc: http://skydoc.bazel.build -->
761+
762+
Rules for creating install scripts from pkg_filegroups and friends.
763+
764+
This module provides an interface (`pkg_install`) for creating a `bazel
765+
run`-able installation script.
766+
767+
<a id="pkg_install"></a>
768+
769+
## pkg_install
770+
771+
<pre>
772+
load("@rules_pkg//pkg:install.bzl", "pkg_install")
773+
774+
pkg_install(<a href="#pkg_install-name">name</a>, <a href="#pkg_install-srcs">srcs</a>, <a href="#pkg_install-destdir">destdir</a>, <a href="#pkg_install-destdir_flag">destdir_flag</a>, <a href="#pkg_install-kwargs">**kwargs</a>)
775+
</pre>
776+
777+
Create an installer script from pkg_filegroups and friends.
778+
779+
This macro allows users to create `bazel run`nable installation scripts
780+
using the pkg_filegroup framework.
781+
782+
For example:
783+
784+
```python
785+
pkg_install(
786+
name = "install",
787+
srcs = [
788+
# mapping/grouping targets here
789+
],
790+
destdir = "out/install",
791+
)
792+
```
793+
794+
Installation can be done by invoking:
795+
796+
```
797+
bazel run -- //path/to:install
798+
```
799+
800+
Additional features can be accessed by invoking the script with the --help
801+
option:
802+
803+
```
804+
bazel run -- //path/to:install --help
805+
```
806+
807+
WARNING: While this rule does function when being run from within a bazel
808+
rule, such use is not recommended. If you do, **always** use the
809+
`--destdir` argument to specify the desired location for the installation to
810+
occur. Not doing so can lead the outputs going to an unexpected location,
811+
or in some cases, failing. Run the script command with `--help`, as
812+
mentioned above, for more details.
813+
814+
One such use would be to run the script created by `pkg_install` to produce
815+
a directory output in the build root. This may not function as expected or
816+
may suffer from poorly tested edge cases. A purpose-written rule that would
817+
allow for creation of such directories is discussed in
818+
https://github.com/bazelbuild/rules_pkg/issues/388.
819+
820+
821+
**PARAMETERS**
822+
823+
824+
| Name | Description | Default Value |
825+
| :------------- | :------------- | :------------- |
826+
| <a id="pkg_install-name"></a>name | rule name | none |
827+
| <a id="pkg_install-srcs"></a>srcs | pkg_filegroup framework mapping or grouping targets | none |
828+
| <a id="pkg_install-destdir"></a>destdir | The default destination directory.<br><br>If it is specified, this is the default destination to install the files. It is overridable by explicitly specifying `--destdir` in the command line or specifying the `DESTDIR` environment variable.<br><br>If it is not specified, `--destdir` must be set on the command line, or the `DESTDIR` environment variable must be set.<br><br>If this is an absolute path, it is used as-is. If this is a relative path, it is interpreted against `BUILD_WORKSPACE_DIRECTORY`. | `None` |
829+
| <a id="pkg_install-destdir_flag"></a>destdir_flag | A string_flag target used to obtain the value of destdir. | `None` |
830+
| <a id="pkg_install-kwargs"></a>kwargs | common rule attributes | none |
831+
832+
833+
834834
<!-- Generated with Stardoc: http://skydoc.bazel.build -->
835835

836836
Rules to create RPM archives.

0 commit comments

Comments
 (0)