Skip to content

Commit

Permalink
docs: add more content
Browse files Browse the repository at this point in the history
  • Loading branch information
mgred committed Feb 20, 2024
1 parent 5094b31 commit 5dbfb5b
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 12 deletions.
26 changes: 21 additions & 5 deletions diff.bzl
Original file line number Diff line number Diff line change
@@ -1,14 +1,30 @@
"Create and Update Patches"
"""
# `diff` Utils
Create and Update Patches
```starlark
load("@bzlparty_tools//:diff.bzl", "diff", "update_patches")
diff(
name = "module_bazel",
source = "//:MODULE.bazel",
target = ":MODULE.bazel",
)
update_patches()
```
> [!NOTE]
> The `diff` rule uses the `diff` command from the host system.
> There is no toolchain that uses a platform specific tool.
"""

load("@aspect_bazel_lib//lib:write_source_files.bzl", "write_source_files")

def diff(name, source, target, input = None):
"""Create a patch file from `source` and `target` files.
> [!NOTE]
> This is a simple rule that uses the `diff` command from the host system.
> There is no toolchain that uses a platform specific tool.
Args:
name: A unique name for the target.
source: Source file to create the patch for.
Expand Down
25 changes: 20 additions & 5 deletions docs/diff.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,27 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->


# `diff` Utils

Create and Update Patches

```starlark
load("@bzlparty_tools//:diff.bzl", "diff", "update_patches")

diff(
name = "module_bazel",
source = "//:MODULE.bazel",
target = ":MODULE.bazel",
)

update_patches()
```

&gt; [!NOTE]
&gt; The `diff` rule uses the `diff` command from the host system.
&gt; There is no toolchain that uses a platform specific tool.


<a id="diff"></a>

## diff
Expand All @@ -12,11 +32,6 @@ diff(<a href="#diff-name">name</a>, <a href="#diff-source">source</a>, <a href="

Create a patch file from `source` and `target` files.

&gt; [!NOTE]
&gt; This is a simple rule that uses the `diff` command from the host system.
&gt; There is no toolchain that uses a platform specific tool.


**PARAMETERS**


Expand Down
6 changes: 5 additions & 1 deletion docs/platforms.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->

Default platform mapping and helpers

# Platforms

Default platform mappings and helpers


<a id="host_platform"></a>

Expand Down
6 changes: 5 additions & 1 deletion platforms.bzl
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
"Default platform mapping and helpers"
"""
# Platforms
Default platform mappings and helpers
"""

load("@local_config_platform//:constraints.bzl", "HOST_CONSTRAINTS")

Expand Down

0 comments on commit 5dbfb5b

Please sign in to comment.