Skip to content

Commit

Permalink
Actually add the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ctiller committed Jan 6, 2017
1 parent d9ed57c commit f687cb8
Show file tree
Hide file tree
Showing 10 changed files with 38 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/core/ext/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Optional plugins for gRPC Core: Modules in this directory extend gRPC Core in
useful ways.

NOTE: The movement of code between lib and ext is an ongoing effort, so this
directory currently contains too much of the core library.
3 changes: 3 additions & 0 deletions src/core/ext/resolver/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Resolver

Implementations of various name resolution schemes.
1 change: 1 addition & 0 deletions src/core/ext/transport/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Transports for gRPC
1 change: 1 addition & 0 deletions src/core/ext/transport/chttp2/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
CHTTP2 - gRPC's implementation of a HTTP2 based transport
5 changes: 5 additions & 0 deletions src/core/lib/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Required elements of gRPC Core: Each module in this directory is required to
build gRPC.

NOTE: The movement of code between lib and ext is an ongoing effort, so this
directory currently contains too much of the core library.
4 changes: 4 additions & 0 deletions src/core/lib/channel/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Channel

Provides channel/call stack implementation, and implementation of common filters
for that implementation.
6 changes: 6 additions & 0 deletions src/core/lib/iomgr/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# iomgr

Platform abstractions for I/O (mostly network).

Provides abstractions over TCP/UDP I/O, file loading, polling, and concurrency
management for various operating systems.
4 changes: 4 additions & 0 deletions src/core/lib/surface/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Surface

Surface provides the bulk of the gRPC Core public API, and translates it into
calls against core components.
7 changes: 7 additions & 0 deletions src/core/lib/transport/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Transport

Common implementation details for gRPC Transports.

Transports multiplex messages across some single connection. In ext/ there are
implementations atop [a custom http2 implementation](/src/core/ext/transport/chttp2/README.md)
and atop [cronet](/src/core/ext/transport/cronet/README.md).
2 changes: 2 additions & 0 deletions src/core/lib/tsi/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Transport Security Interface
An abstraction library over crypto and auth modules (typically OpenSSL)

0 comments on commit f687cb8

Please sign in to comment.