docs/adding_to_third_party.md - Issue 2584723005: Add information for checking in large files in adding_to_third_party.md

Side by Side Diff: docs/adding_to_third_party.md

Issue 2584723005: Add information for checking in large files in adding_to_third_party.md (Closed)

Patch Set: Fix internal link with goto Created 4 years ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

« no previous file with comments | « no previous file | no next file » | no next file with comments »

OLD	NEW
1 # Adding third_party Libraries	1 # Adding third_party Libraries

2	2

3 [TOC]	3 [TOC]

4	4

5 Using third party code can save time and is consistent with our values - no need	5 Using third party code can save time and is consistent with our values - no need

6 to reinvent the wheel! We put all code that isn't written by Chromium developers	6 to reinvent the wheel! We put all code that isn't written by Chromium developers

7 into src/third_party (even if you end up modifying just a few functions). We do	7 into src/third_party (even if you end up modifying just a few functions). We do

8 this to make it easy to track license compliance, security patches, and supply	8 this to make it easy to track license compliance, security patches, and supply

9 the right credit and attributions. It also makes it a lot easier for other	9 the right credit and attributions. It also makes it a lot easier for other

10 projects that embed our code to track what is Chromium licensed and what is	10 projects that embed our code to track what is Chromium licensed and what is

(...skipping 85 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
96 developers that don't need your code. When all platforms really do need the	96 developers that don't need your code. When all platforms really do need the

97 code, checking it in to src/third_party allows some slight improvements over	97 code, checking it in to src/third_party allows some slight improvements over

98 DEPS._	98 DEPS._

99	99

100 As for specifying the path where the library is fetched, a path like	100 As for specifying the path where the library is fetched, a path like

101 `src/third_party/<project_name>/src` is highly recommended so that you can put	101 `src/third_party/<project_name>/src` is highly recommended so that you can put

102 the file like OWNERS or README.chromium at `third_party/<project_name>`. If you	102 the file like OWNERS or README.chromium at `third_party/<project_name>`. If you

103 have a wrong path in DEPS and want to change the path of the existing library in	103 have a wrong path in DEPS and want to change the path of the existing library in

104 DEPS, please ask the infrastructure team before committing the change.	104 DEPS, please ask the infrastructure team before committing the change.

105	105

	106 ### Checking in large files

	107 _Accessible to Googlers only. Non-Googlers can email one of the people in

	108 third_party/OWNERS for help._

	109

	110 See [Moving large files to Google Storage](https://goto.google.com/checking-in-l arge-files)

	111

106 ## Setting up ignore	112 ## Setting up ignore

107	113

108 If your code is synced via DEPS, you should add the new directory to Chromium's	114 If your code is synced via DEPS, you should add the new directory to Chromium's

109 `.gitignore`. This is necessary because Chromium's main git repository already	115 `.gitignore`. This is necessary because Chromium's main git repository already

110 contains	116 contains

111 [src/third_party](http://src.chromium.org/viewvc/chrome/trunk/src/third_party/)	117 [src/third_party](http://src.chromium.org/viewvc/chrome/trunk/src/third_party/)

112 and the project synced via DEPS is nested inside of it and its files regarded as	118 and the project synced via DEPS is nested inside of it and its files regarded as

113 untracked. That is, anyone running `git status` from `src/` would see a clutter.	119 untracked. That is, anyone running `git status` from `src/` would see a clutter.

114 Your project's files are tracked by your repository, not Chromium's, so make	120 Your project's files are tracked by your repository, not Chromium's, so make

115 sure the directory is listed in Chromium's `.gitignore`.	121 sure the directory is listed in Chromium's `.gitignore`.

(...skipping 69 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
185	191

186 * Missing license file	192 * Missing license file

187 * Make sure that the license file is present. It should be called 'LICENSE',	193 * Make sure that the license file is present. It should be called 'LICENSE',

188 or otherwise README.chromium file must point to it explicitly.	194 or otherwise README.chromium file must point to it explicitly.

189 * The following files contain a third-party license but are not in a listed	195 * The following files contain a third-party license but are not in a listed

190 third-party directory...	196 third-party directory...

191 * Check if it's a false positive (e.g. 'copyright' word used in a string	197 * Check if it's a false positive (e.g. 'copyright' word used in a string

192 literal), if so, update	198 literal), if so, update

193 [src/tools/copyright_scanner/third_party_files_whitelist.txt](https://code .google.com/p/chromium/codesearch#chromium/src/tools/copyright_scanner/third_par ty_files_whitelist.txt)	199 [src/tools/copyright_scanner/third_party_files_whitelist.txt](https://code .google.com/p/chromium/codesearch#chromium/src/tools/copyright_scanner/third_par ty_files_whitelist.txt)

194 file. Otherwise, please move the code into third_party.	200 file. Otherwise, please move the code into third_party.

OLD	NEW