diff --git a/docs/development/README.md b/docs/development/README.md index 86c36e58ef11d645108493cd84e42befa12cb6e1..bd3a68fb35ccbb9e3c9872bbaa74579ff59b9f0c 100644 --- a/docs/development/README.md +++ b/docs/development/README.md @@ -19,7 +19,7 @@ and debugging Fuchsia and programs running on Fuchsia. - [Trace-based Benchmarking][trace_based_benchmarking] - [LibFuzzer-based fuzzing](workflows/libfuzzer.md) - [Build system](build/README.md) - - [Workflow FAQ](workflows/workflow_faq.md) + - [Workflow tips and FAQ](workflows/workflow_tips_and_faq.md) - [Testing FAQ](workflows/testing_faq.md) ## Languages diff --git a/docs/development/workflows/workflow_tips.md b/docs/development/workflows/workflow_tips.md deleted file mode 100644 index d4f25fd475a9d259b81382a443c821924fd2f6e7..0000000000000000000000000000000000000000 --- a/docs/development/workflows/workflow_tips.md +++ /dev/null @@ -1,26 +0,0 @@ -# Workflow tips - -This is a list of tips that should help you be more productive when working on fuchsia. - -## Gerrit Monitor - -Install the [Gerrit Monitor](https://chrome.google.com/webstore/detail/gerrit-monitor/leakcdjcdifiihdgalplgkghidmfafoh) -Chrome extension to have in the Chrome toolbar the list of CLs requiring your -attention. - -## Enabling three-way diffs in Git - -By default Git uses two-way diffs when presenting conflicts. It does not -display what the original text was before the conflict, which makes it [hard to -solves some conflicts](https://stackoverflow.com/questions/4129049/why-is-a-3-way-merge-advantageous-over-a-2-way-merge). - -You can configure Git to show the original text by enabling three-way diffs: - -```git config --global merge.conflictstyle diff3``` - -## Enabling fuchsia-specific git commands - -Add `$FUCHSIA_REPO/scripts` to your PATH to be able to use fuchsia-specific git -commands such as `git fuchsia-review [<commit ref>]`, which opens the current -or given commit in gerrit. - diff --git a/docs/development/workflows/workflow_faq.md b/docs/development/workflows/workflow_tips_and_faq.md similarity index 93% rename from docs/development/workflows/workflow_faq.md rename to docs/development/workflows/workflow_tips_and_faq.md index 06ac338777c406fe128410cbd73aad74521881d3..b5788ad1d96984d76dce08a335ccc245b4ab12cf 100644 --- a/docs/development/workflows/workflow_faq.md +++ b/docs/development/workflows/workflow_tips_and_faq.md @@ -1,3 +1,30 @@ +# Workflow: Tips + +This is a list of tips that should help you be more productive when working on fuchsia. + +## Gerrit Monitor + +Install the [Gerrit Monitor](https://chrome.google.com/webstore/detail/gerrit-monitor/leakcdjcdifiihdgalplgkghidmfafoh) +Chrome extension to have in the Chrome toolbar the list of CLs requiring your +attention. + +## Enabling three-way diffs in Git + +By default Git uses two-way diffs when presenting conflicts. It does not +display what the original text was before the conflict, which makes it [hard to +solves some conflicts](https://stackoverflow.com/questions/4129049/why-is-a-3-way-merge-advantageous-over-a-2-way-merge). + +You can configure Git to show the original text by enabling three-way diffs: + +```git config --global merge.conflictstyle diff3``` + +## Enabling fuchsia-specific git commands + +Add `$FUCHSIA_REPO/scripts/git` to your PATH to be able to use fuchsia-specific git +commands such as `git fuchsia-review [<commit ref>]`, which opens the current +or given commit in gerrit. + + # Workflow: Questions and Answers You are encouraged to add your own questions (and answers) here! diff --git a/docs/getting_started.md b/docs/getting_started.md index 933509e1b9a37ff51d89adc70d5683a148f1b0b9..2f268915802d04ac973859766c5dae772212a76f 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -278,5 +278,5 @@ You may wish to peruse the [testing FAQ](development/workflows/testing_faq.md). * Working with Zircon - [copying files, network booting, log viewing, and more](/zircon/docs/getting_started.md#Copying-files-to-and-from-Zircon) * [Information on the system bootstrap component](/garnet/bin/sysmgr/). -* [Workflow tips](development/workflows/workflow_tips.md) that help increase +* [Workflow tips and FAQ](development/workflows/workflow_tips_and_faq.md) that help increase productivity.