Move style guide and abseil-in-webrtc into g3doc subfolder

No-Try: true
Bug: None
Change-Id: I45c3e515f6e446f8982333869d8ad2c6ae15978d
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/218347
Reviewed-by: Harald Alvestrand <hta@webrtc.org>
Reviewed-by: Artem Titov <titovartem@webrtc.org>
Commit-Queue: Danil Chapovalov <danilchap@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#34004}
This commit is contained in:
Danil Chapovalov 2021-05-12 14:05:48 +02:00 committed by WebRTC LUCI CQ
parent 0d1435b2d0
commit 46f5c11e4f
9 changed files with 16 additions and 6 deletions

3
OWNERS
View file

@ -13,8 +13,5 @@ per-file AUTHORS=*
per-file DEPS=*
per-file pylintrc=mbonadei@webrtc.org
per-file WATCHLISTS=*
per-file abseil-in-webrtc.md=danilchap@webrtc.org
per-file abseil-in-webrtc.md=mbonadei@webrtc.org
per-file style-guide.md=danilchap@webrtc.org
per-file native-api.md=mbonadei@webrtc.org
per-file *.lua=titovartem@webrtc.org

View file

@ -24,7 +24,7 @@ native API header files.
* Samples and reference apps: https://github.com/webrtc
* Mailing list: http://groups.google.com/group/discuss-webrtc
* Continuous build: https://ci.chromium.org/p/webrtc/g/ci/console
* [Coding style guide](style-guide.md)
* [Coding style guide](g3doc/style-guide.md)
* [Code of conduct](CODE_OF_CONDUCT.md)
* [Reporting bugs](docs/bug-reporting.md)

View file

@ -1,6 +1,6 @@
# How to write code in the `api/` directory
Mostly, just follow the regular [style guide](../style-guide.md), but:
Mostly, just follow the regular [style guide](../g3doc/style-guide.md), but:
* Note that `api/` code is not exempt from the “`.h` and `.cc` files come in
pairs” rule, so if you declare something in `api/path/to/foo.h`, it should be
@ -17,7 +17,7 @@ it from a `.cc` file, so that users of our API headers wont transitively
For headers in `api/` that need to refer to non-public types, forward
declarations are often a lesser evil than including non-public header files. The
usual [rules](../style-guide.md#forward-declarations) still apply, though.
usual [rules](../g3doc/style-guide.md#forward-declarations) still apply, though.
`.cc` files in `api/` should preferably be kept reasonably small. If a
substantial implementation is needed, consider putting it with our non-public

View file

@ -1,2 +1,5 @@
titovartem@webrtc.org
per-file abseil-in-webrtc.md=danilchap@webrtc.org
per-file abseil-in-webrtc.md=mbonadei@webrtc.org
per-file style-guide.md=danilchap@webrtc.org

View file

@ -1,5 +1,8 @@
# Using Abseil in WebRTC
<?% config.freshness.owner = 'danilchap' %?>
<?% config.freshness.reviewed = '2021-05-12' %?>
You may use a subset of the utilities provided by the [Abseil][abseil]
library when writing WebRTC C++ code. Below, we list the explicitly
*allowed* and the explicitly *disallowed* subsets of Abseil; if you

View file

@ -1,6 +1,7 @@
* [Home](/g3doc/index.md)
* How to contribute
* Code
* [Style guide](/g3doc/style-guide.md)
* [Documentation](/g3doc/how_to_write_documentation.md)
* [Public C++ API](/api/g3doc/index.md)
* [Threading](/api/g3doc/threading_design.md)

View file

@ -1,5 +1,8 @@
# WebRTC coding style guide
<?% config.freshness.owner = 'danilchap' %?>
<?% config.freshness.reviewed = '2021-05-12' %?>
## General advice
Some older parts of the code violate the style guide in various ways.

View file

@ -1,5 +1,8 @@
# `.h` and `.cc` files come in pairs
<?% config.freshness.owner = 'danilchap' %?>
<?% config.freshness.reviewed = '2021-05-12' %?>
This is an overflow page for [this](../style-guide.md#h-cc-pairs)
style rule.