+1 -1

src/docs/contributor/javascript_coding_standards.diviner

reviewed

··· 107 107 break; 108 108 } 109 109 110 110 - ##break## statements should be indented to block level. If you don't push them 110 110 + `break` statements should be indented to block level. If you don't push them 111 111 in, you end up with an inconsistent rule for conditional ##break## statements, 112 112 as in the ##2## case. 113 113

+1 -1

src/docs/contributor/php_coding_standards.diviner

reviewed

··· 112 112 break; 113 113 } 114 114 115 115 - ##break## statements should be indented to block level. 115 115 + `break` statements should be indented to block level. 116 116 117 117 **array literals:** 118 118

+1 -1

src/docs/contributor/using_oauthserver.diviner

reviewed

··· 6 6 = Overview = 7 7 8 8 Phabricator includes an OAuth Server which supports the 9 9 - ##Authorization Code Grant## flow as described in the OAuth 2.0 9 9 + `Authorization Code Grant` flow as described in the OAuth 2.0 10 10 specification: 11 11 12 12 http://tools.ietf.org/html/draft-ietf-oauth-v2-23

+1 -1

src/docs/flavor/javascript_pitfalls.diviner

reviewed

··· 29 29 30 30 = ##with## is Bad News = 31 31 32 32 - ##with## is a pretty bad feature, for this reason among others: 32 32 + `with` is a pretty bad feature, for this reason among others: 33 33 34 34 with (object) { 35 35 property = 3; // Might be on object, might be on window: who knows.

+3 -3

src/docs/flavor/php_pitfalls.diviner

reviewed

··· 153 153 = array_uintersect() and array_udiff() are Definitely Slow Too = 154 154 155 155 These functions have the problems of both the ##usort()## family and the 156 156 - ##array_diff()## family. Avoid them. 156 156 + `array_diff()` family. Avoid them. 157 157 158 158 = foreach() Does Not Create Scope = 159 159 160 160 Variables survive outside of the scope of foreach(). More problematically, 161 161 references survive outside of the scope of foreach(). This code mutates 162 162 - ##$array## because the reference leaks from the first loop to the second: 162 162 + `$array` because the reference leaks from the first loop to the second: 163 163 164 164 COUNTEREXAMPLE 165 165 $array = range(1, 3); ··· 276 276 277 277 This is because the successor to 'z' is 'aa', which is "less than" 'z'. The 278 278 loop will run for ~700 iterations until it reaches 'zz' and terminates. That is, 279 279 - ##$c## will take on these values: 279 279 + `$c` will take on these values: 280 280 281 281 a 282 282 b

+1 -1

src/docs/tech/celerity.diviner

reviewed

··· 46 46 resources (so you only have to explicitly include what you're actually using, 47 47 and not all of its dependencies) and any packaging rules (so it may be able to 48 48 generate fewer resource requests, improving performance). It then generates 49 49 - ##<script />## and ##<link />## references to these resources. 49 49 + `<script />` and `<link />` references to these resources. 50 50 51 51 These references point at ##/res/## URIs, which are handled by 52 52 @{class:CelerityResourceController}. It responds to these requests and delivers

+1 -1

src/docs/tech/chatbot.diviner

reviewed

··· 67 67 68 68 To allow the bot to access Conduit, you need to create a user that it can login 69 69 with. To do this, login to Phabricator as an administrator and go to 70 70 - ##People -> Create New Account##. Create a new account and flag them as a 70 70 + `People -> Create New Account`. Create a new account and flag them as a 71 71 "Bot/Script". Then in your configuration file, set these parameters: 72 72 73 73 - ##conduit.uri## The URI for your Phabricator install, like

+2 -2

src/docs/tech/conduit.diviner

reviewed

··· 44 44 45 45 There is a web interface for viewing and testing Conduit called the "Conduit 46 46 Console", implemented by @{class:PhabricatorConduitConsoleController} at 47 47 - ##/conduit/##. 47 47 + `/conduit/`. 48 48 49 49 A log of connections and calls is stored by 50 50 @{class:PhabricatorConduitConnectionLog} and ··· 52 52 @{class:PhabricatorConduitLogController} at ##/conduit/log/##. 53 53 54 54 Conduit provides a token-based handshake mechanism used by 55 55 - ##arc install-certificate## at ##/conduit/token/##, implemented by 55 55 + `arc install-certificate` at `/conduit/token/`, implemented by 56 56 @{class:PhabricatorConduitTokenController} which stores generated tokens using 57 57 @{class:PhabricatorConduitCertificateToken}.

+1 -1

src/docs/tech/files.diviner

reviewed

··· 36 36 @{class:PhabricatorFileStorageEngineSelector}, provide an implementation which 37 37 selects your storage engine for whatever files you want to store there, and then 38 38 configure Phabricator to use your selector by setting 39 39 - ##storage.engine-selector##. 39 39 + `storage.engine-selector`.

+1 -1

src/docs/user/configuration/configuring_accounts_and_registration.diviner

reviewed

··· 44 44 = Managing Accounts with the Web Console = 45 45 46 46 To manage accounts from the web, login as an administrator account and go to 47 47 - ##/people/## or click "People" on the homepage. Provided you're an admin, 47 47 + `/people/` or click "People" on the homepage. Provided you're an admin, 48 48 you'll see options to create or edit accounts. 49 49 50 50 = Manually Creating New Accounts =

+5 -5

src/docs/user/configuration/configuring_inbound_email.diviner

reviewed

··· 179 179 180 180 ...you need to edit your php.ini file so that mbstring.so is loaded **before** 181 181 mailparse.so. This is not the default if you have individual files in 182 182 - ##php.d/##. 182 182 + `php.d/`. 183 183 184 184 = Local MTA: Configuring Sendmail = 185 185 ··· 197 197 - restart sendmail. 198 198 199 199 Now, you can actually configure sendmail to deliver to Phabricator. In 200 200 - ##/etc/aliases##, add an entry like this: 200 200 + `/etc/aliases`, add an entry like this: 201 201 202 202 phabricator: "| /path/to/phabricator/scripts/mail/mail_handler.php <ENV>" 203 203 204 204 ...where <ENV> is the PHABRICATOR_ENV the script should run under. Run 205 205 - ##sudo newaliases##. Now you likely need to symlink this script into 206 206 - ##/etc/smrsh/##: 205 205 + `sudo newaliases`. Now you likely need to symlink this script into 206 206 + `/etc/smrsh/`: 207 207 208 208 sudo ln -s /path/to/phabricator/scripts/mail/mail_handler.php /etc/smrsh/ 209 209 ··· 213 213 214 214 That will forward all mail to @yourdomain.com to the Phabricator processing 215 215 script. Run ##sudo /etc/mail/make## or similar and then restart sendmail with 216 216 - ##sudo /etc/init.d/sendmail restart##. 216 216 + `sudo /etc/init.d/sendmail restart`. 217 217 218 218 = Local MTA: Configuring Lamson = 219 219

+11 -3

src/docs/user/configuration/custom_fields.diviner

reviewed

··· 59 59 "type": "int", 60 60 "caption": "Actual number of hours this took." 61 61 }, 62 62 + "mycompany:company-jobs": { 63 63 + "name": "Job Role", 64 64 + "type: "select", 65 65 + "options": { 66 66 + "mycompany:engineer": "Engineer", 67 67 + "mycompany:nonengineer": "Other" 68 68 + } 69 69 + }, 62 70 "mycompany:favorite-dinosaur": { 63 71 "name": "Favorite Dinosaur", 64 72 "type": "text" 65 65 - } 73 73 + }, 66 74 } 67 75 68 76 The fields will then appear in the other config option for the application ··· 82 90 - **int**: An integer, rendered as a text field. 83 91 - **text**: A string, rendered as a text field. 84 92 - **bool**: A boolean value, rendered as a checkbox. 85 85 - - **select**: Allows the user to select from several options, rendered 86 86 - as a dropdown. 93 93 + - **select**: Allows the user to select from several options as defined 94 94 + by **options**, rendered as a dropdown. 87 95 - **remarkup**: A text area which allows the user to enter markup. 88 96 - **users**: A typeahead which allows multiple users to be input. 89 97 - **date**: A date/time picker.

+1 -1

src/docs/user/installation_guide.diviner

reviewed

··· 73 73 74 74 If those work for you, you can skip directly to the 75 75 @{article:Configuration Guide}. These scripts are also available in the 76 76 - ##scripts/install## directory in the project itself. 76 76 + `scripts/install` directory in the project itself. 77 77 78 78 Otherwise, here's a general description of what you need to install: 79 79

+2 -2

src/docs/user/userguide/arcanist_lint_unit.diviner

reviewed

··· 57 57 it has loaded your library. 58 58 59 59 For debugging or testing, you can also run Arcanist with the 60 60 - ##--load-phutil-library## flag: 60 60 + `--load-phutil-library` flag: 61 61 62 62 arc --load-phutil-library=/path/to/library <command> 63 63 64 64 You can specify this flag more than once to load several libraries. Note that 65 65 if you use this flag, Arcanist will ignore any libraries listed in 66 66 - ##.arcconfig##. 66 66 + `.arcconfig`. 67 67 68 68 = Use the Class = 69 69

+2 -2

src/docs/user/userguide/diffusion_symbols.diviner

reviewed

··· 61 61 $ find . -type f -name '*.php' | ./scripts/symbols/generate_php_symbols.php 62 62 63 63 To actually build the symbol index, pipe this data to the 64 64 - ##import_project_symbols.php## script, providing the project name: 64 64 + `import_project_symbols.php` script, providing the project name: 65 65 66 66 $ ./scripts/symbols/import_project_symbols.php yourproject < symbols_data 67 67 ··· 77 77 To configure Differential integration, you need to tell Phabricator which 78 78 projects have symbol indexes you want to use, and which other projects they 79 79 should pull symbols from. To do this, go to 80 80 - ##Repositories -> Arcanist Projects -> Edit## as an administrator. You need to 80 80 + `Repositories -> Arcanist Projects -> Edit` as an administrator. You need to 81 81 fill out these fields: 82 82 83 83 - **Repository**: Associate the project with a tracked repository.

+2 -2

src/docs/user/userguide/libraries.diviner

reviewed

··· 80 80 But, if you intend to use this library with Phabricator, you need to define its 81 81 dependency on Phabricator by creating a ##.arcconfig## file which points at 82 82 Phabricator. For example, you might write this file to 83 83 - ##libcustom/.arcconfig##: 83 83 + `libcustom/.arcconfig`: 84 84 85 85 { 86 86 "project.name" : "libcustom", ··· 134 134 135 135 When developing libraries to work with libphutil, Arcanist and Phabricator, you 136 136 should respect method and property visibility and extend only classes marked 137 137 - ##@stable##. They are rendered with a large callout in the documentation (for 137 137 + `@stable`. They are rendered with a large callout in the documentation (for 138 138 example: @{class@libphutil:AbstractDirectedGraph}). These classes are external 139 139 interfaces intended for extension. 140 140

+1 -1

src/docs/user/userguide/mail_rules.diviner

reviewed

··· 35 35 to route and manage mail. 36 36 37 37 Headers in plural contain lists. A list containing two items, ##1## and 38 38 - ##15## will generally be formatted like this: 38 38 + `15` will generally be formatted like this: 39 39 40 40 X-Header: <1>, <15> 41 41

+1 -1

src/docs/user/userguide/remarkup.diviner

reviewed

··· 213 213 } 214 214 215 215 You can use ##lines=N## to limit the vertical size of a chunk of code, and 216 216 - ##name=some_name.ext## to give it a name. For example, this: 216 216 + `name=some_name.ext` to give it a name. For example, this: 217 217 218 218 lang=text 219 219 lang=html, name=example.html, lines=12, counterexample