Skip to content
This repository was archived by the owner on Nov 10, 2023. It is now read-only.

Commit 97e1ef7

Browse files
authored
Update some Buck documentation from whitelist to allowlist (#2574)
Summary: Conversion to more inclusive terminology for parts of public Buck documentation where the renaming does not conflict with API names. Reviewed By: bobyangyf fbshipit-source-id: eb7f6e96f7a43513b848b26d77eb06991eb5e4c6
1 parent 2b0ee31 commit 97e1ef7

File tree

2 files changed

+17
-17
lines changed

2 files changed

+17
-17
lines changed

docs/concept/buckd.soy

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -40,26 +40,26 @@ graph and action graph.
4040
<p>
4141
The Buck daemon writes its port, process id, and log output to files in
4242
a <code>.buckd</code>{sp} directory that the daemon creates in the
43-
project root directory. Subsequent Buck commands use these files to
43+
project root directory. Subsequent Buck commands use these files to
4444
find the daemon process, and a new Buck daemon process will use
4545
them to kill any already-existing daemon process.
4646
</p>
4747

4848
<p>
4949
It is safe to run multiple Buck daemons started from different project
50-
directories as they do not interfere with each other,
51-
making <code>buckd</code> suitable for use in shared-server environments
50+
directories as they do not interfere with each other,
51+
making <code>buckd</code> suitable for use in shared-server environments
5252
or where several projects are being worked on concurrently.
5353
</p>
5454

5555
<p>
5656
While it runs, the Buck daemon process monitors the project's file
5757
system and invalidates cached build rules if any build input files
58-
change. The Buck daemon excludes from monitoring any subtrees of the
58+
change. The Buck daemon excludes from monitoring any subtrees of the
5959
project file system that are specified in
6060
the {call buckconfig.project_ignore /} setting
61-
of <code>.buckconfig</code>. By adding project-specific output
62-
directories and source-control directories, such as<code>.git</code>, to
61+
of <code>.buckconfig</code>. By adding project-specific output
62+
directories and source-control directories, such as<code>.git</code>, to
6363
this setting, you can significantly improve performance; this might be necessary
6464
to avoid file-change overflows when using Buck daemons to build large
6565
projects.
@@ -81,7 +81,7 @@ The Buck daemon process is killed if
8181
</p>
8282

8383
<p>
84-
You can also kill the Buck daemon explicitly by
84+
You can also kill the Buck daemon explicitly by
8585
running {call buck.cmd_kill /} in the directory tree for your project.
8686
Note that if&mdash;for some reason&mdash;multiple instances of the
8787
daemon are running, the <code>buck kill</code> command kills only one of
@@ -95,7 +95,7 @@ restarts.</em>
9595
</p>
9696

9797
<p>
98-
To disable the daemon and prevent it from starting, set the environment
98+
To disable the daemon and prevent it from starting, set the environment
9999
variable {sp}<code>NO_BUCKD</code> to <code>1</code>. For example:
100100
</p>
101101

@@ -112,8 +112,8 @@ buck build project_name
112112
<h4>Buck configuration changes invalidate the daemon's state</h4>
113113
<p>
114114
If you change Buck's configuration, it invalidates any cached state
115-
stored by the Buck daemon&mdash;unless that change is to
116-
a <em>small subset</em> of configuration settings that are whitelisted
115+
stored by the Buck daemon&mdash;unless that change is to
116+
a <em>small subset</em> of configuration settings that are supported
117117
in <a
118118
href="https://github.com/facebook/buck/blob/master/src/com/facebook/buck/command/config/AbstractConfigIgnoredByDaemon.java"><code>AbstractConfigIgnoredByDaemon.java</code></a>.
119119
</p>
@@ -124,18 +124,18 @@ the following:
124124
<p>
125125
<pre>
126126
{literal}
127-
Invalidating internal cached state:
128-
Buck configuration options changed between invocations.
127+
Invalidating internal cached state:
128+
Buck configuration options changed between invocations.
129129
This may cause slower builds.
130130
{/literal}
131131
</pre>
132132
</p>
133133

134134
<p>
135-
Note that a Buck configuration change that invalidates the daemon's state can be
136-
caused not only by explicitly changing a setting in one of Buck's
137-
configuration files, such as <code>.buckconfig</code> or <code>.buckconfig.local</code>, but also by using
138-
the <code>--config</code>, <code>--flagfile</code>, or <code>--config-file</code> {call buck.cmd_link}{param name: 'common_parameters' /}{param rendered_text: ' command-line parameters' /}{/call}.
135+
Note that a Buck configuration change that invalidates the daemon's state can be
136+
caused not only by explicitly changing a setting in one of Buck's
137+
configuration files, such as <code>.buckconfig</code> or <code>.buckconfig.local</code>, but also by using
138+
the <code>--config</code>, <code>--flagfile</code>, or <code>--config-file</code> {call buck.cmd_link}{param name: 'common_parameters' /}{param rendered_text: ' command-line parameters' /}{/call}.
139139
</p>
140140

141141
{/param} // content

docs/concept/visibility.soy

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ targets a target can depend on.
4444
</p>
4545

4646
<p>
47-
Both attributes act as whitelists, with some exceptions. In general, if a target
47+
Both attributes act as allowlists, with some exceptions. In general, if a target
4848
is not listed, there may be no dependency relationship. If
4949
the <code>within_view</code> list is empty or unset, however, its check is
5050
bypassed. Similarly, targets defined in the same build file always act as if

0 commit comments

Comments
 (0)