Skip to content

Commit c677795

Browse files
fjhenigmanCommit Bot
authored and
Commit Bot
committed
docs: fix links and typos
Update stale/broken links. Use consistent link style: - links between our files should relative - omit filename for links within same file - don't specify heading id Don't use same heading twice in one file because the markdown compilers on googlesource.com and github have different ways of disambiguating them, so this is the easiest way to have links work on both sites. BUG=angleproject:1569 Change-Id: Iefd5ab8014d582a017f64e383f301ea0b8e60433 Reviewed-on: https://chromium-review.googlesource.com/789445 Reviewed-by: Yuly Novikov <[email protected]> Reviewed-by: Geoff Lang <[email protected]> Commit-Queue: Frank Henigman <[email protected]>
1 parent d3e213b commit c677795

11 files changed

+39
-44
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,13 @@ View the [Dev setup instructions](doc/DevSetup.md). For generating a Windows Sto
5555

5656
* Join our [Google group](https://groups.google.com/group/angleproject) to keep up to date.
5757
* Join us on IRC in the #ANGLEproject channel on FreeNode.
58-
* File bugs in the [issue tracker](http://code.google.com/p/angleproject/issues/list) (preferably with an isolated test-case).
58+
* File bugs in the [issue tracker](https://bugs.chromium.org/p/angleproject/issues/list) (preferably with an isolated test-case).
5959
* [Choose an ANGLE branch](doc/ChoosingANGLEBranch.md) to track in your own project.
6060

6161

6262
* Read ANGLE development [documentation](doc).
63-
* Look at [pending](https://chromium-review.googlesource.com/#/q/project:angle/angle+status:open)
64-
and [merged](https://chromium-review.googlesource.com/#/q/project:angle/angle+status:merged) changes.
63+
* Look at [pending](https://chromium-review.googlesource.com/q/project:angle/angle+status:open)
64+
and [merged](https://chromium-review.googlesource.com/q/project:angle/angle+status:merged) changes.
6565
* Become a [code contributor](doc/ContributingCode.md).
6666
* Use ANGLE's [coding standard](doc/CodingStandard.md).
6767
* Learn how to [build ANGLE for Chromium development](doc/BuildingAngleForChromiumDevelopment.md).

doc/BuildingAngleForWindowsStore.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Gyp will generate multiple VS2015 solution files
3333

3434

3535
### Building ANGLE
36-
1. Open one of the ANGLE Visual Studio solution files (see [Getting the source](BuildingAngleForWindowsStore.md#Development-setup-Getting-the-source)).
36+
1. Open one of the ANGLE Visual Studio solution files (see [Getting the source](#getting-the-source)).
3737
2. Select Build -> Configuration Manager
3838
3. In the "Active solution configuration:" drop down, select the desired configuration (eg. Release), and close the Configuration Manager.
3939
4. Select Build -> Build Solution.
@@ -46,11 +46,11 @@ Once the build completes, the output directory for your selected configuration (
4646
* Right-click your project in the _Solution Explorer_, and select _Properties_.
4747
* Under the _Configuration Properties_ branch, click _C/C++_.
4848
* Add the relative path to the Khronos EGL and GLES2 header files to _Additional Include Directories_.
49-
3. Configure your build environment to have access to `libEGL.lib` and `libGLESv2.lib` found in the build output directory (see [Building ANGLE](DevSteup.md#Building-ANGLE)).
49+
3. Configure your build environment to have access to `libEGL.lib` and `libGLESv2.lib` found in the build output directory (see [Building ANGLE](DevSetup.md#building-angle-on-windows)).
5050
* For Visual C++
5151
* Right-click your project in the _Solution Explorer_, and select _Properties_.
5252
* Under the _Configuration Properties_ branch, open the _Linker_ branch and click _Input_.
5353
* Add the relative paths to both the `libEGL.lib` file and `libGLESv2.lib` file to _Additional Dependencies_, separated by a semicolon.
54-
4. Copy `libEGL.dll` and `libGLESv2.dll` from the build output directory (see [Building ANGLE](DevSetup.md#Building-ANGLE)) into your application folder or packages location if a ANGLE Windows Store NuGet was used.
54+
4. Copy `libEGL.dll` and `libGLESv2.dll` from the build output directory (see [Building ANGLE](DevSetup.md#building-angle-on-windows)) into your application folder or packages location if a ANGLE Windows Store NuGet was used.
5555
5. Code your application to the Khronos [OpenGL ES 2.0](http://www.khronos.org/registry/gles/) and [EGL 1.4](http://www.khronos.org/registry/egl/) APIs.
5656

doc/CodingStandard.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Google Style Guide
44

55
We generally use the [Google C++ Style Guide]
6-
(http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml) as a basis for
6+
(https://google.github.io/styleguide/cppguide.html) as a basis for
77
our Coding Standard, however we will deviate from it in a few areas, as noted
88
below.
99

@@ -13,23 +13,23 @@ Items marked {DEV} indicate a deviation from the Google guidelines. Items marked
1313
Before you upload code to Gerrit, use `git cl format` to auto-format your code.
1414
This will catch most of the trivial formatting errors and save you time.
1515

16-
### [Header Files](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Header_Files)
16+
### [Header Files](https://google.github.io/styleguide/cppguide.html#Header_Files)
1717

1818
* We will use **`.h`** for C++ headers.
1919
* {DEV} #define guards should be of the form: `<PATH>_<FILE>_H_`. (Compiler
2020
codebase is varied, including `<PROJECT>_` makes the names excessively
2121
long).
2222

23-
### [Scoping](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Scoping)
23+
### [Scoping](https://google.github.io/styleguide/cppguide.html#Scoping)
2424

2525
* {DO} avoid globally scoped variables, unless absolutely necessary.
2626

27-
### [Classes](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Classes)
27+
### [Classes](https://google.github.io/styleguide/cppguide.html#Classes)
2828

2929
* {DEV} Inherit (privately) from angle::NonCopyable helper class (defined in
3030
common/angleutils.h) to disable default copy and assignment operators.
3131

32-
### [Other C++ Features](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Other_C++_Features)
32+
### [Other C++ Features](https://google.github.io/styleguide/cppguide.html#Other_C++_Features)
3333

3434
* {DEV} all parameters passed by reference, except for STL containers (e.g.
3535
std::vector, std::list), must be labeled `const`. For return parameters
@@ -42,7 +42,7 @@ This will catch most of the trivial formatting errors and save you time.
4242
* {DO} use C++11 according to the [Chromium guide on C++11]
4343
(http://chromium-cpp.appspot.com/).
4444

45-
### [Naming ](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Naming)
45+
### [Naming](https://google.github.io/styleguide/cppguide.html#Naming)
4646

4747
#### File Names
4848

@@ -74,7 +74,7 @@ use CamelCase (chosen for consistency)
7474
* macros: all uppercase with underscores
7575
* exceptions to naming: use common sense!
7676

77-
### [Comments](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Comments)
77+
### [Comments](https://google.github.io/styleguide/cppguide.html#Comments)
7878

7979
* {DO} read and follow Google's recommendations.
8080
* Each file **must** start with the following boilerplate notice:
@@ -87,7 +87,7 @@ use CamelCase (chosen for consistency)
8787
//
8888
```
8989

90-
### [Formatting](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Formatting)
90+
### [Formatting](https://google.github.io/styleguide/cppguide.html#Formatting)
9191

9292
* {DEV} Avoid excessively long lines. Please keep lines under 100 columns
9393
long.
@@ -149,7 +149,7 @@ char *c;
149149
const string &str;
150150
```
151151

152-
### [Exceptions to the Rules](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Exceptions_to_the_Rules)
152+
### [Exceptions to the Rules](https://google.github.io/styleguide/cppguide.html#Exceptions_to_the_Rules)
153153

154154
* If modifying pre-existing code that does not match the standard, the altered
155155
portions of the code should be changed to match the standard.

doc/CompilingTranslatorWithEmscripten.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ about how to do this.
1010

1111
Pull top of tree ANGLE.
1212

13-
Install the Emscripten toolchain per the [instructions]
14-
(http://kripken.github.io/emscripten-site/).
13+
Install the Emscripten toolchain per the [instructions](http://emscripten.org/).
1514

1615
Symlink (preferred) or copy the ANGLE directory into ...emsdk/emscripten/master.
1716

doc/ContributingCode.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Communicate
44

55
* Whether you're writing a new feature or fixing an existing bug, it pays to get a second opinion before you get too far. If it's a new feature idea, post to the discussion group ([angleproject](https://groups.google.com/forum/?fromgroups#!forum/angleproject)) and propose it or talk with the ANGLE team on IRC in the #ANGLEproject channel on FreeNode.
6-
* Not all bugs in our [bug system](https://code.google.com/p/angleproject/issues/list) are assigned, but if the one you're interested in fixing is, send a note to the person it's assigned to and ask if they would like a patch.
6+
* Not all bugs in our [bug system](https://bugs.chromium.org/p/angleproject/issues/list) are assigned, but if the one you're interested in fixing is, send a note to the person it's assigned to and ask if they would like a patch.
77
* Behavior changes and anything nontrivial (i.e. anything other than simple cleanups and style fixes) should generally be tracked in the bug system. Please [file a bug](http://anglebug.com/new) and describe what you're doing if there isn't one already.
88

99
## Get your code ready
@@ -15,15 +15,15 @@
1515
### Build maintenance
1616
1. If you added or removed source files:
1717
* You _must_ update the gyp build scripts lists with your changes. See `src/libEGL.gypi`, `src/libGLESv2.gypi`, and `src/compiler.gypi`.
18-
2. ANGLE also now maintains a BUILD.gn script for [Chromium's gn build](https://code.google.com/p/chromium/wiki/gn). If you changed the gyp files other than to add or remove new files, you will also need to update BUILD.gn. Ask a project member for help with testing if you don't have a Chromium checkout.
18+
2. ANGLE also now maintains a BUILD.gn script for [Chromium's gn build](https://www.chromium.org/developers/gn-build-configuration). If you changed the gyp files other than to add or remove new files, you will also need to update BUILD.gn. Ask a project member for help with testing if you don't have a Chromium checkout.
1919
3. If you modified `glslang.y` or `glslang.l`:
2020
* You _must_ update the bison-generated compiler sources. Download and install the latest 64-bit Bison and flex from official [Cygwin](https://cygwin.com/install.html) on _Windows_. From the Cygwin shell run `generate_parser.sh` in `src/compiler/translator` and update your CL. Do not edit the generated files by hand.
2121
* _NOTE:_ You can ignore failing chunk messages if there are no compile errors.
2222
* If you modified `ExpressionParser.y` or `Tokenizer.l`, follow the same process by running `src/compiler/preprocessor/generate_parser.sh`.
2323

2424
### Testing
2525
* ANGLE uses trybots to test on a variety of platforms. Please run your changes against our bots and check the results before landing changes or requesting reviews.
26-
* Upload your change (see [Making changes](ContributingCode.md#making-changes)).
26+
* Upload your change (see [Making changes](#making-changes)).
2727
* To kick of a try job, use the 'CQ Dry Run' button, or set the Commit-Queue +1 label to trigger a dry run of the CQ (will not land the change).
2828
* If you are not part of the `angle-committers` group, you will need to either ask to be added or ask a member of the group to submit the tryjob for you. Add jmadill or geofflang as a reviewer for assistance.
2929
* Wait for the bots to report the result on the code review page. The bot results should be visible in Gerrit as yellow (in-progress), green (passed), or red (failed). This can take up to two hours for some of the debug bots. Click on the colored rectangle to open the bot log to triage failed tests.
@@ -41,7 +41,7 @@
4141
* ANGLE also includes the [drawElements Quality Program (dEQP)](dEQP.md) for additional testing. If you're working on a new feature, there may be some extensive tests for it already written.
4242

4343
### Legal
44-
1. You must complete the [Individual Contributor License Agreement](http://code.google.com/legal/individual-cla-v1.0.html). You can do this online, and it only takes a minute. If you are contributing on behalf of a corporation, you must fill out the [Corporate Contributor License Agreement](http://code.google.com/legal/corporate-cla-v1.0.html) and send it to Google as described on that page.
44+
1. You must complete the [Individual Contributor License Agreement](https://cla.developers.google.com/about/google-individual). You can do this online, and it only takes a minute. If you are contributing on behalf of a corporation, you must fill out the [Corporate Contributor License Agreement](https://cla.developers.google.com/about/google-corporate) and send it to Google as described on that page.
4545
2. Once you've submitted the CLA, please email the following information (as entered on the CLA) to `shannonwoods at chromium dot org` for record keeping purposes:
4646
* Full Name:
4747
* Email:
@@ -63,7 +63,7 @@
6363
* Download the hook from [https://chromium-review.googlesource.com/tools/hooks/commit-msg](https://chromium-review.googlesource.com/tools/hooks/commit-msg) and copy this file to `.git/hooks/commit-msg` within your local repository. On non-Windows, platforms, ensure that permissions are set to allow execution.
6464
* *BE AWARE:* Some patch management tools, such as StGit, currently bypass git hooks. They should not currently be used with changes intended for review.
6565

66-
### Making changes {#making-changes}
66+
### Making changes
6767
1. Commit your changes locally:
6868
* `git add src/../FileName.cpp`
6969
* `git commit`
@@ -79,7 +79,7 @@
7979
3. Upload the change list
8080
* `git cl upload`
8181
* The change list and modified files will be uploaded to
82-
[ANGLE Gerrit](https://chromium-review.googlesource.com/#/q/project:angle/angle).
82+
[ANGLE Gerrit](https://chromium-review.googlesource.com/q/project:angle/angle).
8383
* Follow the generated URL to the new issue.
8484
* Take a moment to perform a self-review of your code. Gerrit's viewer makes it easy to see whitespace errors, erroneous tabs, and other simple style problems.
8585
* Designate reviewers-- if you don't do this, reviewers may not realize you're requesting a review!
@@ -98,7 +98,7 @@
9898

9999
See also:
100100

101-
* [ANGLE Gerrit](https://chromium-review.googlesource.com/#/q/project:angle/angle)
101+
* [ANGLE Gerrit](https://chromium-review.googlesource.com/q/project:angle/angle)
102102
* [Chromium Projects: Contributing Code](http://www.chromium.org/developers/contributing-code/)
103103
* [depot_tools tutorial](http://commondatastorage.googleapis.com/chrome-infra-docs/flat/depot_tools/docs/html/depot_tools_tutorial.html)
104104

doc/DevSetup.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,12 @@ git checkout master
5959

6060
GYP will generate the project files, if you update ANGLE or make a change to the projects, they can be regenerated by executing `gclient runhooks`.
6161

62-
On Windows GYP will generate the main VS2015 solution file as gyp/ANGLE.sln. For generating a Windows Store version of ANGLE view the [Windows Store instructions](doc/BuildingAngleForWindowsStore.md).
62+
On Windows GYP will generate the main VS2015 solution file as gyp/ANGLE.sln. For generating a Windows Store version of ANGLE view the [Windows Store instructions](BuildingAngleForWindowsStore.md).
6363

6464
On Linux and MacOS, GYP will generate the `out/Debug` and `out/Release` directories.
6565

6666
### Building ANGLE on Windows
67-
1. Open one of the ANGLE Visual Studio solution files (see [Getting the source](DevSetup.md#Development-setup-Getting-the-source)).
67+
1. Open one of the ANGLE Visual Studio solution files (see [Getting the source](#getting-the-source)).
6868
2. Select Build -> Configuration Manager
6969
3. In the "Active solution configuration:" drop down, select the desired configuration (eg. Release), and close the Configuration Manager.
7070
4. Select Build -> Build Solution.
@@ -78,7 +78,7 @@ Once the build completes, the `out/Debug` or `out/Release` directories will cont
7878
Presently, it is not possible to build standalone ANGLE for Android.
7979
But, ANGLE for Android can be built within a Chromium checkout.
8080
The reason for that is a dependency on Chromium for Android toolchain and that it only supports GN.
81-
Also, it can only be built on Linux, as this is the only platfrom that Chromium for Android supports.
81+
Also, it can only be built on Linux, as this is the only platform that Chromium for Android supports.
8282
In theory, once ANGLE supports standalone GN build, it may be possible to put Chromium for Android toolchain in `third_party` or `buildtools` to build standalone ANGLE for Android.
8383

8484
But, for now, the steps in [Checking out and building Chromium for Android](https://chromium.googlesource.com/chromium/src/+/master/docs/android_build_instructions.md) should be followed to check out Chromium for Android and set up build environment.
@@ -114,7 +114,7 @@ adb pull /sdcard/chromium_tests_root/third_party/deqp/src/data/TestResults.qpa .
114114

115115
In order to run GPU telemetry tests, build `chrome_public_apk` target. Then follow [GPU Testing](http://www.chromium.org/developers/testing/gpu-testing#TOC-Running-the-GPU-Tests-Locally) doc, using `--browser=android-chromium` argument. Make sure to set your `CHROMIUM_OUT_DIR` environment variable, so that your browser is found, otherwise the stock one will run.
116116

117-
Also, follow [How to build ANGLE in Chromium for dev](https://chromium.googlesource.com/angle/angle/+/HEAD/doc/BuildingAngleForChromiumDevelopment.md) to work with Top of Tree ANGLE in Chromium.
117+
Also, follow [How to build ANGLE in Chromium for dev](BuildingAngleForChromiumDevelopment.md) to work with Top of Tree ANGLE in Chromium.
118118

119119
## Application Development with ANGLE
120120
This sections describes how to use ANGLE to build an OpenGL ES application.
@@ -137,12 +137,12 @@ On Windows:
137137
* Right-click your project in the _Solution Explorer_, and select _Properties_.
138138
* Under the _Configuration Properties_ branch, click _C/C++_.
139139
* Add the relative path to the Khronos EGL and GLES2 header files to _Additional Include Directories_.
140-
2. Configure your build environment to have access to `libEGL.lib` and `libGLESv2.lib` found in the build output directory (see [Building ANGLE](DevSteup.md#Building-ANGLE)).
140+
2. Configure your build environment to have access to `libEGL.lib` and `libGLESv2.lib` found in the build output directory (see [Building ANGLE](#building-angle-on-windows)).
141141
* For Visual C++
142142
* Right-click your project in the _Solution Explorer_, and select _Properties_.
143143
* Under the _Configuration Properties_ branch, open the _Linker_ branch and click _Input_.
144144
* Add the relative paths to both the `libEGL.lib` file and `libGLESv2.lib` file to _Additional Dependencies_, separated by a semicolon.
145-
3. Copy `libEGL.dll` and `libGLESv2.dll` from the build output directory (see [Building ANGLE](DevSetup.md#Building-ANGLE)) into your application folder.
145+
3. Copy `libEGL.dll` and `libGLESv2.dll` from the build output directory (see [Building ANGLE](#building-angle-on-windows)) into your application folder.
146146
4. Code your application to the Khronos [OpenGL ES 2.0](http://www.khronos.org/registry/gles/) and [EGL 1.4](http://www.khronos.org/registry/egl/) APIs.
147147

148148
On Linux and MacOS, either:
@@ -153,8 +153,9 @@ On Linux and MacOS, either:
153153
## GLSL ES to GLSL Translator
154154
In addition to OpenGL ES 2.0 and EGL 1.4 libraries, ANGLE also provides a GLSL ES to GLSL translator. This is useful for implementing OpenGL ES emulators on top of desktop OpenGL.
155155

156-
### Getting the source
157-
The translator code is fully independent of the rest of ANGLE code and resides in `src/compiler`. It is cross-platform and build files for operating systems other than Windows can be generated by following the `Generating project files` steps above.
156+
### Source and Building
157+
The translator code is included with ANGLE but fully independent; it resides in `src/compiler`.
158+
Follow the steps above for [getting and building ANGLE](#getting-the-source) to build the translator on the platform of your choice.
158159

159160
### Usage
160161
The basic usage is shown in `essl_to_glsl` sample under `samples/translator`. To translate a GLSL ES shader, following functions need to be called in the same order:

doc/ExtensionSupport.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ Specifications for EGL extensions can be found in the [Khronos EGL API Registry]
99
(http://www.khronos.org/registry/egl/)
1010

1111
Specifications for ANGLE-specific extensions can be found in the [ANGLE
12-
extension registry]
13-
(https://code.google.com/p/angleproject/source/browse/?name=master#git%2Fextensions)
12+
extension registry](../extensions)
1413

1514
# Details
1615

doc/Update20130618.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ contributors pulling from the svn repository will continue to be able to do so,
1010
but please note that this repository is now read-only, and no further updates
1111
will be made there. To continue tracking new development and issue fixes, you'll
1212
need to watch the git repository. Instructions on checking out code from the git
13-
repository can be found on the [Source Checkout]
14-
(https://code.google.com/p/angleproject/source/checkout) page.
13+
repository can be found on the [Source Checkout](https://code.google.com/p/angleproject/source/checkout) page.
1514

1615
## DirectX 11 Support
1716

0 commit comments

Comments
 (0)