From 18de3d723902b441f670600a4cbe19ad3634010a Mon Sep 17 00:00:00 2001
From: Vijay Pai <vpai@google.com>
Date: Fri, 17 Mar 2017 15:28:13 -0700
Subject: [PATCH] Make changes suggested by Mark, make this pass sanity
---
doc/combiner-explainer.md | 8 ++++----
tools/doxygen/Doxyfile.c++ | 1 +
tools/doxygen/Doxyfile.c++.internal | 1 +
tools/doxygen/Doxyfile.core | 1 +
tools/doxygen/Doxyfile.core.internal | 1 +
5 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/doc/combiner-explainer.md b/doc/combiner-explainer.md
index 9d0a4f30f2..9e9d077273 100644
--- a/doc/combiner-explainer.md
+++ b/doc/combiner-explainer.md
@@ -92,7 +92,7 @@ class combiner {
So that explains how combiners work in general. In gRPC, there is
`start_batch(..., tag)` and then work only gets activated by somebody
-calling `cq::next` which returns a tag. This gives and API-level
+calling `cq::next` which returns a tag. This gives an API-level
guarantee that there will be a thread doing polling to actually make
work happen. However, some operations are not covered by a poller
thread, such as cancellation that doesn't have a completion. Other
@@ -128,12 +128,12 @@ tries to spray events onto as many threads as possible to get as much concurrenc
So `offload` really does:
```
- distributor.run(continue_from_while_loop);
+ workqueue.run(continue_from_while_loop);
break;
```
-This needs us to add another class variable for a `distributor`
-(called a `workqueue` in the code).
+This needs us to add another class variable for a `workqueue`
+(which is really conceptually a distributor).
```
workqueue::run(f) {
diff --git a/tools/doxygen/Doxyfile.c++ b/tools/doxygen/Doxyfile.c++
index b5021ede15..5e6333dc89 100644
--- a/tools/doxygen/Doxyfile.c++
+++ b/tools/doxygen/Doxyfile.c++
@@ -764,6 +764,7 @@ INPUT = doc/PROTOCOL-HTTP2.md \
doc/PROTOCOL-WEB.md \
doc/binary-logging.md \
doc/c-style-guide.md \
+doc/combiner-explainer.md \
doc/command_line_tool.md \
doc/compression.md \
doc/compression_cookbook.md \
diff --git a/tools/doxygen/Doxyfile.c++.internal b/tools/doxygen/Doxyfile.c++.internal
index 758ba2402a..8b7ec50a93 100644
--- a/tools/doxygen/Doxyfile.c++.internal
+++ b/tools/doxygen/Doxyfile.c++.internal
@@ -764,6 +764,7 @@ INPUT = doc/PROTOCOL-HTTP2.md \
doc/PROTOCOL-WEB.md \
doc/binary-logging.md \
doc/c-style-guide.md \
+doc/combiner-explainer.md \
doc/command_line_tool.md \
doc/compression.md \
doc/compression_cookbook.md \
diff --git a/tools/doxygen/Doxyfile.core b/tools/doxygen/Doxyfile.core
index cd3f2af44c..355029ec9e 100644
--- a/tools/doxygen/Doxyfile.core
+++ b/tools/doxygen/Doxyfile.core
@@ -764,6 +764,7 @@ INPUT = doc/PROTOCOL-HTTP2.md \
doc/PROTOCOL-WEB.md \
doc/binary-logging.md \
doc/c-style-guide.md \
+doc/combiner-explainer.md \
doc/command_line_tool.md \
doc/compression.md \
doc/compression_cookbook.md \
diff --git a/tools/doxygen/Doxyfile.core.internal b/tools/doxygen/Doxyfile.core.internal
index e4f56f2374..a3507274ec 100644
--- a/tools/doxygen/Doxyfile.core.internal
+++ b/tools/doxygen/Doxyfile.core.internal
@@ -764,6 +764,7 @@ INPUT = doc/PROTOCOL-HTTP2.md \
doc/PROTOCOL-WEB.md \
doc/binary-logging.md \
doc/c-style-guide.md \
+doc/combiner-explainer.md \
doc/command_line_tool.md \
doc/compression.md \
doc/compression_cookbook.md \
--
GitLab