Skip to content

Commit 4ca768e

Browse files
evie404copybara-github
authored andcommitted
standardize graph output indentation with 2 spaces
Currently, when outputting graphs from Bazel with `bazel query --output=graph`, the indentations for different types of lines are inconsistent: - `node` is indented with 2 spaces - edges and vertices are not indented - labels are indented with 1 space Example using [rules_go](https://github.com/bazelbuild/rules_go): ``` $ bazel query "deps(//gg/platform:darwin)" --output=graph digraph mygraph { node [shape=box]; "//gg/platform:darwin" "//gg/platform:darwin" -> "//gg/toolchain:darwin" "//gg/toolchain:darwin" "//gg/toolchain:darwin" -> "@bazel_tools//platforms:osx" "@bazel_tools//platforms:osx" "@bazel_tools//platforms:osx" -> "@bazel_tools//platforms:os" "@bazel_tools//platforms:os" } Loading: 0 packages loaded ``` It would be nice for the indentations to be present (for edges and vertices), and consistent. As for the indentation scheme, it seems inconclusive as to which type the language prefers: - the [DOT Language Spec](https://www.graphviz.org/doc/info/lang.html) does not really specify tabs or spaces, but the examples used either contained no indentation (!) or one with 2 spaces - the official [examples](https://www.graphviz.org/gallery/) contain samples of no indentation, tabs, or 2 spaces, with tabs being most popular - the [Wikipedia page](https://en.wikipedia.org/wiki/DOT_(graph_description_language)) uses tabs I'm using 2 spaces to conform with skylark. This is the result from the same query with this PR: ```plaintext $ /Users/ricky/workspace/bazel/bazel-bin/src/bazel query "deps(//gg/platform:darwin)" --output=graph Starting local Bazel server and connecting to it... DEBUG: /private/var/tmp/_bazel_ricky/5c63e3be3c60ec773878bdf16f25adcc/external/bazel_toolchains/rules/version_check.bzl:45:9: Current running Bazel is not a release version and one was not defined explicitly in rbe_autoconfig target. Falling back to '0.23.0' digraph mygraph { node [shape=box]; "//gg/platform:darwin" "//gg/platform:darwin" -> "//gg/toolchain:darwin" "//gg/toolchain:darwin" "//gg/toolchain:darwin" -> "@bazel_tools//platforms:osx" "@bazel_tools//platforms:osx" "@bazel_tools//platforms:osx" -> "@bazel_tools//platforms:os" "@bazel_tools//platforms:os" } Loading: 3 packages loaded ``` Closes #8007. PiperOrigin-RevId: 251296052
1 parent 3ed9d36 commit 4ca768e

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

src/main/java/com/google/devtools/build/lib/graph/DotOutputVisitor.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,11 @@ public void endVisit() {
5858
public void visitEdge(Node<T> lhs, Node<T> rhs) {
5959
String s_lhs = disp.serialize(lhs);
6060
String s_rhs = disp.serialize(rhs);
61-
out.println("\"" + s_lhs + "\" -> \"" + s_rhs + "\"");
61+
out.println(" \"" + s_lhs + "\" -> \"" + s_rhs + "\"");
6262
}
6363

6464
@Override
6565
public void visitNode(Node<T> node) {
66-
out.println("\"" + disp.serialize(node) + "\"");
66+
out.println(" \"" + disp.serialize(node) + "\"");
6767
}
6868
}

src/main/java/com/google/devtools/build/lib/query2/query/output/GraphOutputFormatter.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ public void visitEdge(Node<Target> lhs, Node<Target> rhs) {
103103
getConditionsGraphLabel(
104104
ImmutableSet.of(lhs), ImmutableSet.of(rhs), conditionalEdges);
105105
if (!outputLabel.isEmpty()) {
106-
out.printf(" [label=\"%s\"];\n", outputLabel);
106+
out.printf(" [label=\"%s\"];\n", outputLabel);
107107
}
108108
}
109109
},
@@ -195,7 +195,7 @@ public void visitEdge(Node<Set<Node<Target>>> lhs, Node<Set<Node<Target>>> rhs)
195195
String outputLabel =
196196
getConditionsGraphLabel(lhs.getLabel(), rhs.getLabel(), conditionalEdges);
197197
if (!outputLabel.isEmpty()) {
198-
out.printf(" [label=\"%s\"];\n", outputLabel);
198+
out.printf(" [label=\"%s\"];\n", outputLabel);
199199
}
200200
}
201201
},

0 commit comments

Comments
 (0)