aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTony Aiuto <aiuto@google.com>2022-12-21 13:36:42 -0500
committerTony Aiuto <aiuto@google.com>2022-12-21 13:36:42 -0500
commite519ec82719f0b17c9b0b58cfe967c86ba47676f (patch)
treecf2a85a2b5c9aafb82e2e87472dc3e11afefc63a
parentb5543233da4bfeb835489fab5a87794a6b4b11ec (diff)
downloadbazelbuild-rules_license-e519ec82719f0b17c9b0b58cfe967c86ba47676f.tar.gz
remove extra file
-rw-r--r--README.md2
-rw-r--r--doc_build/common.md53
2 files changed, 1 insertions, 54 deletions
diff --git a/README.md b/README.md
index 463e0b2..1527f74 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,7 @@ WARNING: The code here is still in active initial development and will churn a l
If you want to follow along:
- Mailing list: [bazel-ssc@bazel.build](https://groups.google.com/a/bazel.build/g/bazel-ssc)
- Monthly eng meeting: [calendar link](MjAyMjA4MjJUMTYwMDAwWiBjXzUzcHBwZzFudWthZXRmb3E5NzhxaXViNmxzQGc&tmsrc=c_53pppg1nukaetfoq978qiub6ls%40group.calendar.google.com&scp=ALL)
-- [Latest docs](https://bazelbuild.github.io/rules_license/latest.md)
+- [Latest docs](https://bazelbuild.github.io/rules_license/latest.html)
Background reading:
These is for learning about the problem space, and our approach to solutions. Concrete specifications will always appear in checked in code rather than documents.
diff --git a/doc_build/common.md b/doc_build/common.md
deleted file mode 100644
index d2be5ed..0000000
--- a/doc_build/common.md
+++ /dev/null
@@ -1,53 +0,0 @@
-<a name="common"></a>
-
-### Common Attributes
-
-These attributes are used in several rules within this module.
-
-**ATTRIBUTES**
-
-| Name | Description | Type | Mandatory | Default |
-| :------------- | :------------- | :-------------: | :-------------: | :------------- |
-| out | Name of the output file. This file will always be created and used to access the package content. If `package_file_name` is also specified, `out` will be a symlink. | String | required | |
-| package_file_name | The name of the file which will contain the package. The name may contain variables in the forms `{var}` and $(var)`. The values for substitution are specified through `package_variables` or taken from [ctx.var](https://bazel.build/rules/lib/ctx#var). | String | optional | package type specific |
-| package_variables | A target that provides `PackageVariablesInfo` to substitute into `package_file_name`. | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | optional | None |
-| attributes | Attributes to set on entities created within packages. Not to be confused with bazel rule attributes. See 'Mapping "Attributes"' below | Undefined. | optional | Varies. Consult individual rule documentation for details. |
-
-See
-[examples/naming_package_files](https://github.com/bazelbuild/rules_pkg/tree/main/examples/naming_package_files)
-for examples of how `out`, `package_file_name`, and `package_variables`
-interact.
-
-@since(0.8.0): File name substitution now supports the $(var) syntax.
-@since(0.8.0): File name substitution now supports direct use of [ctx.var](https://bazel.build/rules/lib/ctx#var).
-
-
-<a name="mapping-attrs"></a>
-### Mapping "Attributes"
-
-The "attributes" attribute specifies properties of package contents as used in
-rules such as `pkg_files`, and `pkg_mkdirs`. These allow fine-grained control
-of the contents of your package. For example:
-
-```python
-attributes = pkg_attributes(
- mode = "0644",
- user = "root",
- group = "wheel",
- my_custom_attribute = "some custom value",
-)
-```
-
-`mode`, `user`, and `group` correspond to common UNIX-style filesystem
-permissions. Attributes should always be specified using the `pkg_attributes`
-helper macro.
-
-Each mapping rule has some default mapping attributes. At this time, the only
-default is "mode", which will be set if it is not otherwise overridden by the user.
-
-If `user` and `group` are not specified, then defaults for them will be chosen
-by the underlying package builder. Any specific behavior from package builders
-should not be relied upon.
-
-Any other attributes should be specified as additional arguments to
-`pkg_attributes`.