From 305966e748ba4a393804ad552455d2f4003c55b4 Mon Sep 17 00:00:00 2001 From: Austin McKinley Date: Wed, 19 Apr 2017 09:25:59 -0700 Subject: [PATCH] Fixing of the typos Test Plan: doitlive Reviewers: epriestley, chad Reviewed By: epriestley, chad Subscribers: cspeckmim, Korvin Differential Revision: https://secure.phabricator.com/D17727 --- src/docs/contributor/database.diviner | 24 +++++++++---------- src/docs/flavor/project_history.diviner | 6 ++--- .../flavor/things_you_should_do_now.diviner | 4 ++-- 3 files changed, 17 insertions(+), 17 deletions(-) diff --git a/src/docs/contributor/database.diviner b/src/docs/contributor/database.diviner index 59a7dc2b2c..aaea485dc6 100644 --- a/src/docs/contributor/database.diviner +++ b/src/docs/contributor/database.diviner @@ -10,7 +10,7 @@ Database System Phabricator uses MySQL or another MySQL-compatible database (like MariaDB or Amazon RDS). -Phabricator the InnoDB table engine. The only exception is the +Phabricator uses the InnoDB table engine. The only exception is the `search_documentfield` table which uses MyISAM because MySQL doesn't support fulltext search in InnoDB (recent versions do, but we haven't added support yet). @@ -102,7 +102,7 @@ An example of such usage can be found in column Primary Keys ============ -Most tables have auto-increment column named `id`. Adding an ID column is +Most tables have an auto-increment column named `id`. Adding an ID column is appropriate for most tables (even tables that have another natural unique key), as it improves consistency and makes it easier to perform generic operations on objects. @@ -134,12 +134,12 @@ eventually, but there isn't a strong case for them at the present time. PHIDs ===== -Each globally referencable object in Phabricator has its associated PHID +Each globally referencable object in Phabricator has an associated PHID ("Phabricator ID") which serves as a global identifier, similar to a GUID. We use PHIDs for referencing data in different databases. -We use both autoincrementing IDs and global PHIDs because each is useful in -different contexts. Autoincrementing IDs are meaningfully ordered and allow +We use both auto-incrementing IDs and global PHIDs because each is useful in +different contexts. Auto-incrementing IDs are meaningfully ordered and allow us to construct short, human-readable object names (like `D2258`) and URIs. Global PHIDs allow us to represent relationships between different types of objects in a homogeneous way. @@ -154,7 +154,7 @@ Transactions ============ Transactional code should be written using transactions. Example of such code is -inserting multiple records where one doesn't make sense without the other or +inserting multiple records where one doesn't make sense without the other, or selecting data later used for update. See chapter in @{class:LiskDAO}. Advanced Features @@ -195,12 +195,12 @@ set names: | Variable | Meaning | Notes | |---|---|---| -| {$NAMESPACE} | Storage Namespace | Defaults to `phabricator` | -| {$CHARSET} | Default Charset | Mostly used to specify table charset | -| {$COLLATE_TEXT} | Text Collation | For most text (case-sensitive) | -| {$COLLATE_SORT} | Sort Collation | For sortable text (case-insensitive) | -| {$CHARSET_FULLTEXT} | Fulltext Charset | Specify explicitly for fulltext | -| {$COLLATE_FULLTEXT} | Fulltext Collate | Specify explicitly for fulltext | +| `{$NAMESPACE}` | Storage Namespace | Defaults to `phabricator` | +| `{$CHARSET}` | Default Charset | Mostly used to specify table charset | +| `{$COLLATE_TEXT}` | Text Collation | For most text (case-sensitive) | +| `{$COLLATE_SORT}` | Sort Collation | For sortable text (case-insensitive) | +| `{$CHARSET_FULLTEXT}` | Fulltext Charset | Specify explicitly for fulltext | +| `{$COLLATE_FULLTEXT}` | Fulltext Collate | Specify explicitly for fulltext | **Test your patch**. Run `bin/storage upgrade` to test your patch. diff --git a/src/docs/flavor/project_history.diviner b/src/docs/flavor/project_history.diviner index bfdbe2682e..c3b5363d50 100644 --- a/src/docs/flavor/project_history.diviner +++ b/src/docs/flavor/project_history.diviner @@ -52,9 +52,9 @@ problems. I joined the new Dev Tools team around February 2010 and took over Diffcamp. I renamed it to Differential, moved it to a new Alite-based infrastructure with Javelin, and started making it somewhat less terrible. I eventually wrote -Diffusion and build Herald to replace a very difficult-to-use predecessor. These +Diffusion and built Herald to replace a very difficult-to-use predecessor. These tools were less negatively received than the older versions. By December 2010 I started open sourcing them; Haste became //Celerity// and Alite became //Aphront//. I wrote Maniphest to track open issues with the project in January -or February and we open sourced Phabricator in late April, shortly after I left -Facebook. +or February, left Facebook in April, and shortly after, we open sourced +Phabricator. diff --git a/src/docs/flavor/things_you_should_do_now.diviner b/src/docs/flavor/things_you_should_do_now.diviner index b4681bd0ca..0d3b4135ba 100644 --- a/src/docs/flavor/things_you_should_do_now.diviner +++ b/src/docs/flavor/things_you_should_do_now.diviner @@ -134,5 +134,5 @@ query escaping system the rest of the application does. Hopefully, whatever language you're writing in has good query libraries that can handle escaping for you. If so, use them. If you're using PHP and don't have -a solution in place yet, the Phabricator implementation of qsprintf() is similar -to Facebook's system and was successful there. +a solution in place yet, the Phabricator implementation of `qsprintf()` is +similar to Facebook's system and was successful there.