Skip to content

Commit

Permalink
Regenerate documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
illicitonion committed Dec 15, 2024
1 parent 30a66c7 commit 1fab7c1
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
8 changes: 6 additions & 2 deletions docs/src/flatten.md
Original file line number Diff line number Diff line change
Expand Up @@ -1405,8 +1405,8 @@ See `load_arbitrary_tool` in `@rules_rust//rust:repositories.bzl` for more detai
| <a id="rust_register_toolchains-aliases"></a>aliases | A mapping of "full" repository name to another name to use instead. | `{}` |
| <a id="rust_register_toolchains-hub_name"></a>hub_name | The name of the bzlmod hub repository for toolchains. | `None` |
| <a id="rust_register_toolchains-compact_windows_names"></a>compact_windows_names | Whether or not to produce compact repository names for windows toolchains. This is to avoid MAX_PATH issues. | `True` |
| <a id="rust_register_toolchains-toolchain_triples"></a>toolchain_triples | <p align="center"> - </p> | `{"aarch64-apple-darwin": "rust_darwin_aarch64", "aarch64-pc-windows-msvc": "rust_windows_aarch64", "aarch64-unknown-linux-gnu": "rust_linux_aarch64", "s390x-unknown-linux-gnu": "rust_linux_s390x", "x86_64-apple-darwin": "rust_darwin_x86_64", "x86_64-pc-windows-msvc": "rust_windows_x86_64", "x86_64-unknown-freebsd": "rust_freebsd_x86_64", "x86_64-unknown-linux-gnu": "rust_linux_x86_64"}` |
| <a id="rust_register_toolchains-extra_toolchain_infos"></a>extra_toolchain_infos | <p align="center"> - </p> | `None` |
| <a id="rust_register_toolchains-toolchain_triples"></a>toolchain_triples | Mapping of rust target triple -> repository name to create. | `{"aarch64-apple-darwin": "rust_darwin_aarch64", "aarch64-pc-windows-msvc": "rust_windows_aarch64", "aarch64-unknown-linux-gnu": "rust_linux_aarch64", "s390x-unknown-linux-gnu": "rust_linux_s390x", "x86_64-apple-darwin": "rust_darwin_x86_64", "x86_64-pc-windows-msvc": "rust_windows_x86_64", "x86_64-unknown-freebsd": "rust_freebsd_x86_64", "x86_64-unknown-linux-gnu": "rust_linux_x86_64"}` |
| <a id="rust_register_toolchains-extra_toolchain_infos"></a>extra_toolchain_infos | (dict[str, dict], optional): Mapping of information about extra toolchains which were created outside of this call, which should be added to the hub repo. | `None` |


<a id="rust_repositories"></a>
Expand Down Expand Up @@ -1470,6 +1470,10 @@ Assembles a remote repository for the given toolchain params, produces a proxy r
| <a id="rust_repository_set-aliases"></a>aliases | Replacement names to use for toolchains created by this macro. | `{}` |
| <a id="rust_repository_set-compact_windows_names"></a>compact_windows_names | Whether or not to produce compact repository names for windows toolchains. This is to avoid MAX_PATH issues. | `True` |

**RETURNS**

dict[str, dict]: A dict of informations about all generated toolchains.


<a id="rust_test_suite"></a>

Expand Down
8 changes: 6 additions & 2 deletions docs/src/rust_repositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,8 +219,8 @@ See `load_arbitrary_tool` in `@rules_rust//rust:repositories.bzl` for more detai
| <a id="rust_register_toolchains-aliases"></a>aliases | A mapping of "full" repository name to another name to use instead. | `{}` |
| <a id="rust_register_toolchains-hub_name"></a>hub_name | The name of the bzlmod hub repository for toolchains. | `None` |
| <a id="rust_register_toolchains-compact_windows_names"></a>compact_windows_names | Whether or not to produce compact repository names for windows toolchains. This is to avoid MAX_PATH issues. | `True` |
| <a id="rust_register_toolchains-toolchain_triples"></a>toolchain_triples | <p align="center"> - </p> | `{"aarch64-apple-darwin": "rust_darwin_aarch64", "aarch64-pc-windows-msvc": "rust_windows_aarch64", "aarch64-unknown-linux-gnu": "rust_linux_aarch64", "s390x-unknown-linux-gnu": "rust_linux_s390x", "x86_64-apple-darwin": "rust_darwin_x86_64", "x86_64-pc-windows-msvc": "rust_windows_x86_64", "x86_64-unknown-freebsd": "rust_freebsd_x86_64", "x86_64-unknown-linux-gnu": "rust_linux_x86_64"}` |
| <a id="rust_register_toolchains-extra_toolchain_infos"></a>extra_toolchain_infos | <p align="center"> - </p> | `None` |
| <a id="rust_register_toolchains-toolchain_triples"></a>toolchain_triples | Mapping of rust target triple -> repository name to create. | `{"aarch64-apple-darwin": "rust_darwin_aarch64", "aarch64-pc-windows-msvc": "rust_windows_aarch64", "aarch64-unknown-linux-gnu": "rust_linux_aarch64", "s390x-unknown-linux-gnu": "rust_linux_s390x", "x86_64-apple-darwin": "rust_darwin_x86_64", "x86_64-pc-windows-msvc": "rust_windows_x86_64", "x86_64-unknown-freebsd": "rust_freebsd_x86_64", "x86_64-unknown-linux-gnu": "rust_linux_x86_64"}` |
| <a id="rust_register_toolchains-extra_toolchain_infos"></a>extra_toolchain_infos | (dict[str, dict], optional): Mapping of information about extra toolchains which were created outside of this call, which should be added to the hub repo. | `None` |


<a id="rust_repositories"></a>
Expand Down Expand Up @@ -284,6 +284,10 @@ Assembles a remote repository for the given toolchain params, produces a proxy r
| <a id="rust_repository_set-aliases"></a>aliases | Replacement names to use for toolchains created by this macro. | `{}` |
| <a id="rust_repository_set-compact_windows_names"></a>compact_windows_names | Whether or not to produce compact repository names for windows toolchains. This is to avoid MAX_PATH issues. | `True` |

**RETURNS**

dict[str, dict]: A dict of informations about all generated toolchains.


<a id="rust_toolchain_repository"></a>

Expand Down

0 comments on commit 1fab7c1

Please sign in to comment.