Skip to content

Commit

Permalink
Add docs baseline for 0.6.0 (#509)
Browse files Browse the repository at this point in the history
* Add 0.6.0 doc tree
* fix <li>s in stamp docs
* fix the <li> in tables with a stardoc bug workaround.
* remove obsolete reference.md that was imbedded in the wrong place
  • Loading branch information
aiuto authored Jan 28, 2022
1 parent bba8fd2 commit e173e40
Show file tree
Hide file tree
Showing 8 changed files with 766 additions and 998 deletions.
2 changes: 1 addition & 1 deletion CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
* @aiuto @nacl

/deb_packages/ @aiuto
/docs @aiuto @nacl @floriographygoth
/docs @aiuto @nacl @floriographygoth @gregestren

/pkg/rpm/ @nacl
/pkg/tests/rpm/ @nacl
Expand Down
4 changes: 3 additions & 1 deletion doc_build/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,9 @@ genrule(
name = "reference",
srcs = ["%s.md" % rule for rule, _ in ORDER],
outs = ["reference.md"],
cmd = "cat $(SRCS) >$@",
# Compensate for https://github.com/bazelbuild/stardoc/issues/118.
# Convert escaped HTML <li> back to raw text
cmd = "cat $(SRCS) | sed -e 's/&lt;li&gt;/<li>/g' >$@",
)

[
Expand Down
749 changes: 749 additions & 0 deletions docs/0.6.0/reference.md

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ attributes only defined in in the "Legacy" documentation. You may have to
consult more than one place to get a complete picture.

* [Latest Snapshot](latest.md)
* [Version 0.6.0](0.6.0/reference.md)
* [Version 0.5.0](0.5.0/reference.md)
* [Version 0.4.0](0.4.0/reference.md)
* [Legacy](https://github.com/bazelbuild/rules_pkg/blob/main/pkg/docs/reference.md)
4 changes: 2 additions & 2 deletions docs/latest.md
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ pkg_tar_impl(<a href="#pkg_tar_impl-name">name</a>, <a href="#pkg_tar_impl-build
| <a id="pkg_tar_impl-private_stamp_detect"></a>private_stamp_detect | - | Boolean | optional | False |
| <a id="pkg_tar_impl-remap_paths"></a>remap_paths | - | <a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a> | optional | {} |
| <a id="pkg_tar_impl-srcs"></a>srcs | - | <a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a> | optional | [] |
| <a id="pkg_tar_impl-stamp"></a>stamp | Enable file time stamping. Possible values:&lt;ul&gt; &lt;li&gt;stamp = 1: Use the time of the build as the modification time of each file in the archive.&lt;/li&gt; &lt;li&gt;stamp = 0: Use an "epoch" time for the modification time of each file. This gives good build result caching.&lt;/li&gt; &lt;li&gt;stamp = -1: Control the chosen modification time using the --[no]stamp flag.&lt;/li&gt; &lt;/ul&gt; | Integer | optional | 0 |
| <a id="pkg_tar_impl-stamp"></a>stamp | Enable file time stamping. Possible values: <li>stamp = 1: Use the time of the build as the modification time of each file in the archive. <li>stamp = 0: Use an "epoch" time for the modification time of each file. This gives good build result caching. <li>stamp = -1: Control the chosen modification time using the --[no]stamp flag. | Integer | optional | 0 |
| <a id="pkg_tar_impl-strip_prefix"></a>strip_prefix | - | String | optional | "" |
| <a id="pkg_tar_impl-symlinks"></a>symlinks | - | <a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a> | optional | {} |

Expand Down Expand Up @@ -392,7 +392,7 @@ pkg_zip_impl(<a href="#pkg_zip_impl-name">name</a>, <a href="#pkg_zip_impl-mode"
| <a id="pkg_zip_impl-package_variables"></a>package_variables | See Common Attributes | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | optional | None |
| <a id="pkg_zip_impl-private_stamp_detect"></a>private_stamp_detect | - | Boolean | optional | False |
| <a id="pkg_zip_impl-srcs"></a>srcs | List of files that should be included in the archive. | <a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a> | optional | [] |
| <a id="pkg_zip_impl-stamp"></a>stamp | Enable file time stamping. Possible values:&lt;ul&gt; &lt;li&gt;stamp = 1: Use the time of the build as the modification time of each file in the archive.&lt;/li&gt; &lt;li&gt;stamp = 0: Use an "epoch" time for the modification time of each file. This gives good build result caching.&lt;/li&gt; &lt;li&gt;stamp = -1: Control the chosen modification time using the --[no]stamp flag.&lt;/li&gt; &lt;/ul&gt; | Integer | optional | 0 |
| <a id="pkg_zip_impl-stamp"></a>stamp | Enable file time stamping. Possible values: <li>stamp = 1: Use the time of the build as the modification time of each file in the archive. <li>stamp = 0: Use an "epoch" time for the modification time of each file. This gives good build result caching. <li>stamp = -1: Control the chosen modification time using the --[no]stamp flag. | Integer | optional | 0 |
| <a id="pkg_zip_impl-strip_prefix"></a>strip_prefix | - | String | optional | "" |
| <a id="pkg_zip_impl-timestamp"></a>timestamp | Time stamp to place on all files in the archive, expressed as seconds since the Unix Epoch, as per RFC 3339. The default is January 01, 1980, 00:00 UTC.<br><br>Due to limitations in the format of zip files, values before Jan 1, 1980 will be rounded up and the precision in the zip file is limited to a granularity of 2 seconds. | Integer | optional | 315532800 |

Expand Down
Loading

0 comments on commit e173e40

Please sign in to comment.