Meta tags:
Headings (most frequently used words):
of, targets, files, rule, filter, buck, parameters, the, and, set, query, operators, build, attribute, filtering, transitive, closure, dependencies, deps, by, specified, language, executing, multiple, queries, at, once, referencing, args, examples, to, basics, about, concepts, directories, commands, rules, functions, extending, non, target, quoting, arguments, algebraic, operations, intersection, union, difference, group, all, dependency, paths, allpaths, attrfilter, with, regex, attrregexfilter, buildfile, first, order, expressions, first_order_deps, name, direct, input, inputs, type, kind, extract, content, attributes, labels, find, that, own, owner, reverse, rdeps, list, tests, testsof,
Text of the page (most frequently used words):
the (342), buck (110), query (91), foo (67), deps (61), bar (61), #targets (60), #example (60), that (58), for (51), target (51), and (47), build (43), attribute (40), set (39), expr (38), file (36), output (32), operator (32), examples (31), specified (29), you (29), returns (26), name (24), expression (24), tests (23), all (23), graph (23), with (22), owner (20), srcs (20), dot (20), testsof (19), argument (19), files (18), attributes (18), syntax (18), filter (18), format (17), lib (17), are (17), dependencies (17), rule (16), transitive (16), this (16), one (15), three (15), following (15), main (15), operators (15), baz (15), such (15), value (15), cpp (14), which (14), two (14), closure (14), list (14), type (14), not (14), union (14), pattern (13), can (13), allpaths (12), json (11), expressions (11), command (11), from (11), attrfilter (11), parameters (10), app (10), then (10), note (10), use (10), nodes (10), intersect (10), inputs (10), single (9), each (9), arguments (9), rdeps (9), returned (9), argset (9), language (9), evaluates (9), parameter (8), cxx_library (8), multiple (8), outputs (8), results (8), dictionary (8), regular (8), input (8), result (8), depth (8), regex (8), buildfile (7), contains (7), associated (7), their (7), values (7), when (7), path (7), order (7), first (7), those (7), labels (7), paths (7), they (7), kind (7), java_library (6), java (6), matches (6), other (6), png (6), equivalent (6), want (6), myclass (6), only (6), could (6), universe (6), match (6), more (5), source (5), five (5), four (5), directory (5), queries (5), args (5), used (5), addition (5), line (5), include (5), also (5), includes (5), search (5), own (5), quote (5), first_order_deps (5), node (5), cxx_test (4), cxx_binary (4), root (4), library (4), depends (4), directly (4), repository (4), map (4), between (4), correctly (4), using (4), tpng (4), graphviz (4), should (4), but (4), these (4), combine (4), say (4), third (4), direct (4), itself (4), int (4), any (4), ensure (4), second (4), recommend (4), dependency (4), except (4), attrregexfilter (4), filtering (4), quoting (4), rules (3), string (3), shell (3), prebuilt_jar (3), java_test (3), test (3), project (3), keys (3), display (3), libraries (3), apps (3), myapp (3), suppose (3), present (3), difference (3), usage (3), open (3), see (3), specify (3), above (3), its (3), resulting (3), entire (3), provides (3), way (3), define (3), fuga (3), another (3), depend (3), accepts (3), optional (3), integer (3), return (3), unbounded (3), reverse (3), found (3), have (3), context (3), has (3), inputfile (3), find (3), get (3), current (3), evaluation (3), headers (3), given (3), need (3), parsed (3), where (3), uses (3), your (3), group (3), forms (3), symbolic (3), quotes (3), functionality (3), custom (2), macros (2), read_config (2), host_info (2), glob (2), skylark (2), python (2), prebuilt_native_library (2), android_resource (2), android_prebuilt_aar (2), android_library (2), android_aar (2), run (2), common (2), buckconfig (2), concepts (2), what (2), about (2), representation (2), mylib (2), aliases (2), exists (2), foobar (2), mapping (2), defined (2), option (2), works (2), instead (2), into (2), thrift (2), visualize (2), dot_bfs (2), digraph (2), representing (2), will (2), colored (2), according (2), running (2), lines (2), separate (2), different (2), quoted (2), referenced (2), take (2), takes (2), listed (2), evaluated (2), target1 (2), target2 (2), target3 (2), know (2), executing (2), finds (2), obtain (2), beneath (2), would (2), hoge (2), might (2), contain (2), outside (2), structure (2), some (2), indicated (2), literal (2), specifying (2), upper (2), bound (2), omitted (2), was (2), txt (2), consider (2), inverses (2), must (2), because (2), extract (2), content (2), types (2), section (2), below (2), often (2), xpto (2), _test (2), required (2), parsing (2), rather (2), performed (2), both (2), computes (2), rooted (2), formed (2), either (2), term (2), refers (2), filters (2), double (2), forward (2), slash (2), tool (2), image (2), subs (2), parser (2), resolves (2), commutative (2), operations (2), over (2), nominal (2), form (2), intersection (2), period (2), hyphen (2), tip (2), alias (2), supports (2), bazel (2), ukraine (2), copyright, facebook, 2013, 2020, building, e2e, extending, rule_exists, repository_name, provider, package_name, subdir_glob, load, include_defs, get_cell_name, get_base_path, flatten_dicts, allow_unsafe_import, add_build_file_dep, dsl, functions, prebuilt_dotnet_library, csharp_library, net, sh_test, sh_binary, prebuilt_rust_library, rust_test, rust_library, rust_binary, rust, python_test, python_library, python_binary, prebuilt_python_library, ocaml_library, ocaml_binary, ocaml, lua_library, lua_binary, cxx_lua_extension, lua, kotlin_test, kotlin_library, kotlin, java_binary, prebuilt_apple_framework, core_data_model, apple_test, apple_resource, apple_package, apple_library, apple_bundle, apple_binary, apple_asset_catalog, ios, prebuilt_haskell_library, haskell_library, haskell_binary, haskell, halide_library, halide, groovy_library, groovy, cgo_library, go_test, go_library, go_binary, d_test, d_library, d_binary, prebuilt_cxx_library_group, prebuilt_cxx_library, cxx_precompiled_header, cxx_genrule, cxx, robolectric_test, ndk_library, keystore, gen_aidl, apk_genrule, android_manifest, android_instrumentation_test, android_instrumentation_apk, android_build_config, android_binary, android, zip_file, worker_tool, test_suite, remote_file, http_file, http_archive, genrule, filegroup, export_file, command_alias, core, exit, codes, uninstall, server, publish, killall, kill, install, fix, fetch, doctor, clean, audit, commands, out, buckjavaargs, directories, abis, http, cache, api, flavors, visibility, daemon, buckd, learn, presentations, faq, performance, tuning, troubleshooting, showcase, makes, fast, cheat, sheet, exopackage, installing, intellij, plugin, tutorial, key, getting, started, basics, resolve, assume, may, providing, times, primary, there, ambiguity, style, suggested, binary, bfs, springgreen2, springgreen3, springgreen1, olivedrab3, indianred1, mediumpurple1, color, definitions, org, instance, elements, sets, converted, substituted, contents, singly, execution, alternative, capital, stored, external, per, symbol, convenient, number, long, persist, control, referencing, useful, subcommands, recall, filename, replaced, add, grouped, otherwise, previous, merges, now, repeat, separated, spaces, done, combining, once, lists, caret, succinct, synonym, wanted, constrain, turn, show, specifies, within, message, possible, owners, case, owns, means, being, reserved, keyword, performing, operation, validates, fact, exist, generates, error, valid, prints, described, information, available, ends, action, ignoring, does, actually, after, been, mai, performs, clauses, partial, positional, scenario, corresponds, max_value, 2147483647, passed, child, recurse, collecting, further, reachable, including, matched, against, identical, before, clause, semantic, than, textual, precisely, compared, visualization, software, describe, graphs, generate, rendered, shows, themselves, merged, subdirectory, invoke, zero, white, space, commas, treats, left, associative, equal, precedence, parentheses, specific, parenthesized, encloses, appear, compute, corresponding, just, faster, algebraic, wiz, requires, always, writing, scripts, construct, user, supplied, said, best, practice, even, doesn, require, necessary, adhere, certain, conditions, comprise, sequences, characters, drawn, alphabet, numerals, colon, underscore, asterisk, start, unnecessary, hover, blocks, later, topic, short, descriptions, filenames, non, pass, most, collection, explicit, linked, detail, inspired, same, lexical, similar, adds, few, subset, com, amazing, enables, retrieve, call, satisfy, support, help, provide, humanitarian, aid, github, issues, docs,
Text of the page (random words):
f all the tests for a build target you can combine the deps and testsof operators into a single call to buck query buck query testsof deps java com example app amazing query language the buck query language was inspired by the bazel query language buck s query language uses the same parser so the lexical syntax is similar buck s query language supports a subset of bazel s query functionality but also adds a few operators such as attrfilter inputs and owner operators buck s query language supports the following operators the name of the operator below is linked to a section that provides more detail about that operator s functionality and syntax allpaths all dependency paths attrfilter rule attribute filtering attrregexfilter rule attribute filtering with regex buildfile build files of targets deps and first order deps transitive closure of dependencies except set difference filter filter targets by name inputs direct input files intersect set intersection kind filter targets by rule type labels extract content of rule attributes owner find targets that own specified files rdeps transitive closure of reverse dependencies set group targets testsof list the tests of the specified targets union set union parameters to operators the most common parameter for a buck query operator is an expression that evaluates to a build target or collection of build targets such an expression could be an explicit build target a build target pattern an alias or the set of targets returned by another buck query operator tip you can pass an alias directly to the buck query command line to see what it resolves to for example buck query app apps myapp app non target parameters in addition to target parameters some buck query operators take string parameters such as filenames owner or regular expressions filter note you can hover over the parameters in the syntax blocks for the query operators later in this topic to obtain short tool tip descriptions of the parameters quoting of arguments it is not necessary to quote arguments if they adhere to certain conditions that is they comprise sequences of characters drawn from the alphabet numerals forward slash colon period hyphen underscore _ or asterisk and they do not start with a hyphen or period for example quoting java_test is unnecessary all that said we do recommend that you quote arguments as a best practice even when buck doesn t require it you should always use quotes when writing scripts that construct buck query expressions from user supplied values note that argument quoting for buck query is in addition to any quoting that your shell requires in the following example double quotes are used for the shell and single quotes are used for the build target expression buck query foo bar wiz algebraic set operations intersection union set difference nominal symbolic intersect union except these three operators compute the corresponding set operations over their arguments each operator has two forms a nominal form such as intersect and a symbolic form such as the two forms are equivalent the symbolic forms are just faster to type for example buck query deps foo bar intersect deps baz lib and buck query deps foo bar deps baz lib both return the targets that appear in the transitive closure of foo bar and baz lib the intersect and union operators are commutative the except operator is not commutative the parser treats all three operators as left associative and of equal precedence so we recommend that you use parentheses if you need to ensure a specific order of evaluation a parenthesized expression resolves to the value of the expression it encloses for example the first two expressions are equivalent but the third is not x intersect y union z x intersect y union z x intersect y union z group targets set syntax set a expr b expr c expr the set a b c operator computes the union of a set of zero or more target expressions separate the targets with white space not commas quote the targets to ensure that they are parsed correctly if you want to invoke buck query on a list of targets then set is a way to group this list in a query example the following command line returns the target main in the build file in the root of the buck project and all the targets from the build file in the myclass subdirectory of the root buck query set main myclass example the following command line returns the merged set union of dependencies for the targets main and subs in the build file in the root of the buck project buck query deps set main subs all dependency paths allpaths syntax allpaths from expr to expr the allpaths from to operator evaluates to the graph formed by paths between the target expressions from and to following the dependencies between nodes for example the value of buck query allpaths foo bar foo bar lib baz is the dependency graph rooted at the single target node foo bar that includes all target nodes that depend on foo bar lib baz the two arguments to allpaths can themselves be expressions for example the command buck query allpaths kind java_library foo bar shows all the paths between any java_library in the repository and the target foo bar we recommend using allpaths with the output format dot parameter to generate a graphviz file that can then be rendered as an image for example buck query allpaths foo bar foo bar lib baz output format dot output file result dot dot tpng result dot o image png graphviz is an open source graph visualization software tool graphviz uses the dot language to describe graphs rule attribute filtering attrfilter syntax attrfilter attribute value expr the attrfilter attribute value expr operator evaluates the given target expression and filters the resulting build targets to those where the specified attribute contains the specified value in this context the term attribute refers to an argument in a build rule such as name headers srcs or deps if the attribute is a single value say name it is compared to the specified value and the target is returned if they match if the attribute is a list the target is returned if that list contains the specified value if the attribute is a dictionary the target is returned if the value exists in either the keys or the values of the dictionary for example buck query attrfilter deps foo bar returns the build targets in the repository that depend on foo bar or more precisely those build targets that include foo bar in their deps argument list the match performed by attrfilter is semantic rather than textual so for example if you have the following deps argument in your build file cxx_binary name main srcs main cpp deps myclass your attrfilter clause should be buck query attrfilter deps myclass note the double forward slash before the second argument to attrfilter rule attribute filtering with regex attrregexfilter syntax attrregexfilter attribute pattern expr the attrregexfilter attribute pattern expr operator is identical to the attrfilter attribute value expr operator except that it takes a regular expression as the second argument it evaluates the given target expression and filters the resulting build targets to those where the specified attribute matches the specified pattern in this context the term attribute refers to an argument in a build rule such as name headers srcs or deps if the attribute is a single value say name it is matched against the specified pattern and the target is returned if they match if the attribute is a list the target is returned if that list contains a value that matches the specified pattern if the attribute is a dictionary the target is returned if the pattern match is found in either the keys or the values of the dictionary build files of targets buildfile syntax buildfile expr the buildfile expr operator evaluates to those build files that define the targets that result from the evaluation of the target expression expr in order to find the build file associated with a source file combine the owner operator with buildfile for example buck query buildfile owner foo bar main cpp first finds the targets that own foo bar main cpp and then returns the build files such as foo bar buck that define those targets transitive closure of dependencies deps and first order deps syntax deps argset expr deps argset expr depth int deps argset expr depth int filter expr deps argset expr depth int first_order_deps the deps x operator evaluates to the graph formed by the transitive closure of the dependencies of its argument set x including the nodes from the argument set itself for example the value of buck query deps foo bar is the dependency graph rooted at the target node foo bar it includes all of the dependencies of foo bar it also includes foo bar itself the deps operator accepts an optional second argument which is an integer literal specifying an upper bound on the depth of the search so deps foo bar 1 evaluates to the direct dependencies of the target foo bar and deps foo bar 2 further includes the nodes directly reachable from the nodes in deps foo bar 1 and so on if the depth parameter is omitted the search is unbounded that is it computes the entire transitive closure of dependencies filter expressions and first_order_deps the deps operator also accepts an optional third argument which is a filter expression that is evaluated for each node and returns the child nodes to recurse on when collecting transitive dependencies this filter expression can use the first_order_deps operator which returns a set that contains the first order dependencies of the current node which is equivalent to deps node 1 for example the query buck query deps foo bar 1 first_order_deps is equivalent to buck query deps foo bar 1 the first_order_deps operator can be used only as an argument passed to deps note that because deps uses positional parameters you must specify the second argument in order to specify the third in this scenario if you want the search to be unbounded we recommend that you use 2147483647 which corresponds to java s integer max_value filter targets by name filter syntax filter regex expr the filter regex expr operator evaluates the specified target expression expr and returns the targets that have a name attribute that matches the specified regular expression regex for example buck query filter library deps foo bar returns the targets in the transitive closure of foo bar that contain the string library in their name attribute the filter operator performs a partial match so both of the following clauses would match a target with the name main buck query filter main buck query filter mai another example buck query filter java labels srcs foo bar returns the java files used to build foo bar you often need to quote the pattern to ensure that regular expressions such as xpto are parsed correctly direct input files inputs syntax inputs expr the inputs expr operator returns the files that are inputs to the target expression expr ignoring all dependencies note that it does not include any files required for parsing such as the buck file rather it returns only the files required to actually run the build after parsing has been performed note also that inputs returns only those input files indicated by the target graph input files that are present in the action graph but not in the target graph are not returned by inputs you could consider the inputs and owner operators to be inverses of each other filter targets by rule type kind syntax kind regex expr the kind regex expr operator evaluates the specified target expression expr and returns the targets where the rule type matches the specified regex for example buck query kind java_library deps foo bar returns all java_library targets in the transitive dependencies of foo bar the specified pattern can be a regular expression for example buck query kind _test returns all targets in the repository with a rule type that ends with _test such as java_test and cxx_test you often need to quote the pattern to ensure that regular expressions such as xpto are parsed correctly to get a list of the available rule types in a given set of targets you could use a command such as the following buck query output attribute buck type which prints all the rule types in the build file in the current directory in json format see output attribute described in the parameters section below for more information extract content of rule attributes labels syntax labels attribute expr the labels attribute expr operator returns the set of build targets and file paths listed in the attribute specified by the attribute parameter in the targets that result from the evaluation of target expression expr valid values for attribute include srcs headers and deps example get all build targets and file paths specified in the srcs attribute for all the rules in the build file in the current directory buck query labels srcs in performing this operation buck validates that any source files referenced in these attributes do in fact exist buck generates an error if they do not example get all the build targets and file paths specified in the deps arguments in the tests of the target foo bar buck query labels deps testsof foo bar note that deps must be quoted because in addition to being a build file attribute it is itself a reserved keyword of the query language find targets that own specified files owner syntax owner inputfile the owner inputfile operator returns the targets that own the specified inputfile in this context own means that the target has the specified file as an input you could consider the owner and inputs operators to be inverses of each other example buck query owner examples 1 txt returns the targets that owns the file examples 1 txt which could be a value such as examples one it is possible for the specified file to have multiple owners in which case owner returns a set of targets if no owner for the file is found owner outputs the message no owner was found for file transitive closure of reverse dependencies rdeps syntax rdeps universe expr argset expr rdeps universe expr argset expr depth int the rdeps universe argset operator returns the reverse dependencies of the argument set argset within the transitive closure of the set universe the universe the returned values include the nodes from the argument set argset itself the rdeps operator accepts an optional third argument which is an integer literal specifying an upper bound on the depth of the search a value of one 1 specifies that buck query should return only direct dependencies if the depth parameter is omitted the search is unbounded example the following example returns the targets in the transitive closure of foo bar that depend directly on example baz buck query rdeps foo bar example baz 1 example the universe expr parameter includes the entire transitive closure of the target pattern specified so some of these targets might be outside the directory structure indicated by that target pattern for example the result set of buck que...
|
