Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(226)

Issue 1052883002: migrate GN docs from the wiki to the repo. (Closed)

Created:
5 years, 8 months ago by Dirk Pranke
Modified:
3 years, 9 months ago
Reviewers:
brettw, Nico, scottmg
CC:
chromium-reviews, tfarina
Base URL:
https://chromium.googlesource.com/chromium/src.git@master
Target Ref:
refs/pending/heads/master
Project:
chromium
Visibility:
Public.

Description

Migrate GN docs from the wiki to the repo. Given that Google Code is shutting down, we need to figure out what to do with docs in the wiki. Gitiles (the tree browser for our Git repo) supports rendering markdown files that are checked in to the repo, so one obvious answer is to migrate the GN docs into the repo (and convert them to markdown); this would also make it easier to keep the docs versioned and in sync with the code. This is a first pass at that. The content is unchanged from the wiki, just converted and manually reformatted to stay within 80 columns where possible (we can't do that for long URLs or wide tables). R=brettw@chromium.org, scottmg@chromium.org BUG=468851 Committed: https://crrev.com/12a4235cfacb206ffc7ba27dd14edd970e5b60e0 Cr-Commit-Position: refs/heads/master@{#323923}

Patch Set 1 : split md_browser out into its own dir #

Total comments: 1
Unified diffs Side-by-side diffs Delta from patch set Stats (+2320 lines, -11 lines) Patch
A tools/gn/README.md View 1 chunk +101 lines, -0 lines 0 comments Download
D tools/gn/README.txt View 1 chunk +0 lines, -11 lines 0 comments Download
A tools/gn/docs/cookbook.md View 1 chunk +653 lines, -0 lines 0 comments Download
A tools/gn/docs/cross_compiles.md View 1 chunk +96 lines, -0 lines 0 comments Download
A tools/gn/docs/faq.md View 1 chunk +124 lines, -0 lines 0 comments Download
A tools/gn/docs/hacking.md View 1 chunk +23 lines, -0 lines 0 comments Download
A tools/gn/docs/language.md View 1 chunk +734 lines, -0 lines 0 comments Download
A tools/gn/docs/quick_start.md View 1 chunk +329 lines, -0 lines 0 comments Download
A tools/gn/docs/standalone.md View 1 chunk +41 lines, -0 lines 1 comment Download
A tools/gn/docs/style_guide.md View 1 chunk +184 lines, -0 lines 0 comments Download
A tools/gn/docs/update_binaries.md View 1 chunk +35 lines, -0 lines 0 comments Download

Messages

Total messages: 18 (8 generated)
Dirk Pranke
split md_browser out into its own dir
5 years, 8 months ago (2015-04-03 02:59:13 UTC) #2
Dirk Pranke
Please take a look? Unfortunately, we don't have great methods for previewing what the rendered ...
5 years, 8 months ago (2015-04-03 03:20:31 UTC) #8
tfarina
On Friday, April 3, 2015, <dpranke@chromium.org> wrote: > Please take a look? > > Unfortunately, ...
5 years, 8 months ago (2015-04-03 03:57:01 UTC) #9
brettw
LGTM rubberstamp
5 years, 8 months ago (2015-04-06 18:09:10 UTC) #10
Dirk Pranke
On 2015/04/03 03:57:01, tfarina wrote: > > Skia built a docserver for this use case. ...
5 years, 8 months ago (2015-04-06 18:11:30 UTC) #11
commit-bot: I haz the power
CQ is trying da patch. Follow status at https://chromium-cq-status.appspot.com/patch-status/1052883002/80001
5 years, 8 months ago (2015-04-06 18:12:22 UTC) #13
commit-bot: I haz the power
Committed patchset #1 (id:80001)
5 years, 8 months ago (2015-04-06 18:42:39 UTC) #14
commit-bot: I haz the power
Patchset 1 (id:??) landed as https://crrev.com/12a4235cfacb206ffc7ba27dd14edd970e5b60e0 Cr-Commit-Position: refs/heads/master@{#323923}
5 years, 8 months ago (2015-04-06 18:43:44 UTC) #15
Nico
https://codereview.chromium.org/1052883002/diff/80001/tools/gn/docs/standalone.md File tools/gn/docs/standalone.md (right): https://codereview.chromium.org/1052883002/diff/80001/tools/gn/docs/standalone.md#newcode41 tools/gn/docs/standalone.md:41: # How the standalone and Chrome builds interact This ...
3 years, 9 months ago (2017-03-20 14:19:26 UTC) #17
Dirk Pranke
3 years, 9 months ago (2017-03-21 00:07:10 UTC) #18
Message was sent while issue was closed.
On 2017/03/20 14:19:26, Nico wrote:
>
https://codereview.chromium.org/1052883002/diff/80001/tools/gn/docs/standalon...
> File tools/gn/docs/standalone.md (right):
> 
>
https://codereview.chromium.org/1052883002/diff/80001/tools/gn/docs/standalon...
> tools/gn/docs/standalone.md:41: # How the standalone and Chrome builds
interact
> This looks truncated. Pasteboard mishap?
> 
> (I noticed 'cause some internal doc --
>
https://docs.google.com/document/d/1i9MsSl6Y14dG0kA8FFcNBaFdMoDee2kUPg3pEH7HK...
> -- pointed out that this file here isn't super helpful.)
> 
> It probably should mention tools/gn/example at least, but if you know how to
> restore what was originally in this document on the wiki that'd probably be
> best.

Hm, good catch. From looking at what the internet archive has, it looks like
that's
actually more-or-less what the page said since day one, i.e., the page always
had
that line at the end and nothing more. Perhaps brettw@ wrote it as a placeholder
and never got back to it. I'm not actually sure what all you'd put in here since
the answer
is just "not at all".

I'll post a CL to just delete the line and glance over the rest of the text.

Powered by Google App Engine
This is Rietveld 408576698