Properly generate readme

ryanbujnowicz · Mar 5, 2022 · 7890e0b · 7890e0b
1 parent 9cabdd0
commit 7890e0b
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -239,7 +239,7 @@ Dependencies of `nix_file` if any.
 <pre>
 nixpkgs_cc_configure(<a href="#nixpkgs_cc_configure-name">name</a>, <a href="#nixpkgs_cc_configure-attribute_path">attribute_path</a>, <a href="#nixpkgs_cc_configure-nix_file">nix_file</a>, <a href="#nixpkgs_cc_configure-nix_file_content">nix_file_content</a>, <a href="#nixpkgs_cc_configure-nix_file_deps">nix_file_deps</a>, <a href="#nixpkgs_cc_configure-repositories">repositories</a>,
                      <a href="#nixpkgs_cc_configure-repository">repository</a>, <a href="#nixpkgs_cc_configure-nixopts">nixopts</a>, <a href="#nixpkgs_cc_configure-quiet">quiet</a>, <a href="#nixpkgs_cc_configure-fail_not_supported">fail_not_supported</a>, <a href="#nixpkgs_cc_configure-exec_constraints">exec_constraints</a>,
-                     <a href="#nixpkgs_cc_configure-target_constraints">target_constraints</a>)
+                     <a href="#nixpkgs_cc_configure-target_constraints">target_constraints</a>, <a href="#nixpkgs_cc_configure-register">register</a>)
 </pre>
 
 Use a CC toolchain from Nixpkgs. No-op if not a nix-based platform.
@@ -441,10 +441,7 @@ default is <code>True</code>
 
 <p>
 
-bool, whether the underlying toolchain should be automatically registered with
-<code>register_toolchains</code>. Useful when you need a more advanced
-toolchain configuration than the one provided here and do not want this partial
-toolchain to be registered as-is.
+bool, enabled by default, Whether to register (with `register_toolchains`) the generated toolchain and install it as the default cc_toolchain.
 
 </p>
 </td>

diff --git a/nixpkgs/nixpkgs.bzl b/nixpkgs/nixpkgs.bzl
@@ -658,7 +658,7 @@ def nixpkgs_cc_configure(
       fail_not_supported: bool, Whether to fail if `nix-build` is not available.
       exec_constraints: Constraints for the execution platform.
       target_constraints: Constraints for the target platform.
-      register: Automatically register the created toolchain with the provided *_constraints. Defaults to True.
+      register: bool, enabled by default, Whether to register (with `register_toolchains`) the generated toolchain and install it as the default cc_toolchain.
     """
 
     nixopts = list(nixopts)