Page MenuHomestyx hydra
Files F209003

No OneTemporary
Actions

View Options

diff --git a/src/applications/config/option/PhabricatorSyntaxHighlightingConfigOptions.php b/src/applications/config/option/PhabricatorSyntaxHighlightingConfigOptions.php
index 00474a5e84..8cb3379ec3 100644
--- a/src/applications/config/option/PhabricatorSyntaxHighlightingConfigOptions.php
+++ b/src/applications/config/option/PhabricatorSyntaxHighlightingConfigOptions.php
@@ -1,135 +1,157 @@
<?php
final class PhabricatorSyntaxHighlightingConfigOptions
extends PhabricatorApplicationConfigOptions {
public function getName() {
return pht('Syntax Highlighting');
}
public function getDescription() {
return pht('Options relating to syntax highlighting source code.');
}
public function getOptions() {
+
+ $caches_href = PhabricatorEnv::getDocLink('Managing Caches');
+
return array(
$this->newOption(
'syntax-highlighter.engine',
'class',
'PhutilDefaultSyntaxHighlighterEngine')
->setBaseClass('PhutilSyntaxHighlighterEngine')
->setSummary(pht('Default non-pygments syntax highlighter engine.'))
->setDescription(
pht(
'Phabricator can highlight PHP by default and use Pygments for '.
'other languages if enabled. You can provide a custom '.
'highlighter engine by extending class '.
'PhutilSyntaxHighlighterEngine.')),
$this->newOption('pygments.enabled', 'bool', false)
->setSummary(
- pht('Should Phabricator shell out to Pygments to highlight code?'))
+ pht('Should Phabricator use Pygments to highlight code?'))
+ ->setBoolOptions(
+ array(
+ pht('Use Pygments'),
+ pht('Do Not Use Pygments'),
+ ))
->setDescription(
pht(
- "If you want syntax highlighting for other languages than PHP ".
- "then you can install the python package 'Pygments', make sure ".
- "the 'pygmentize' script is available in the \$PATH of the ".
- "webserver, and then enable this.")),
+ 'Phabricator supports syntax highlighting a few languages by '.
+ 'default, but you can install Pygments (a third-party syntax '.
+ 'highlighting tool) to provide support for many more languages.'.
+ "\n\n".
+ 'To install Pygments, visit '.
+ '[[ http://pygments.org | pygments.org ]] and follow the '.
+ 'download and install instructions.'.
+ "\n\n".
+ 'Once Pygments is installed, enable this option '.
+ '(`pygments.enabled`) to make Phabricator use Pygments when '.
+ 'highlighting source code.'.
+ "\n\n".
+ 'After you install and enable Pygments, newly created source '.
+ 'code (like diffs and pastes) should highlight correctly. '.
+ 'You may need to clear Phabricator\'s caches to get previously '.
+ 'existing source code to highlight. For instructions on '.
+ 'managing caches, see [[ %s | Managing Caches ]].',
+ $caches_href)),
$this->newOption(
'pygments.dropdown-choices',
'wild',
array(
'apacheconf' => 'Apache Configuration',
'bash' => 'Bash Scripting',
'brainfuck' => 'Brainf*ck',
'c' => 'C',
'coffee-script' => 'CoffeeScript',
'cpp' => 'C++',
'css' => 'CSS',
'd' => 'D',
'diff' => 'Diff',
'django' => 'Django Templating',
'erb' => 'Embedded Ruby/ERB',
'erlang' => 'Erlang',
'go' => 'Golang',
'groovy' => 'Groovy',
'haskell' => 'Haskell',
'html' => 'HTML',
'invisible' => 'Invisible',
'java' => 'Java',
'js' => 'Javascript',
'json' => 'JSON',
'mysql' => 'MySQL',
'objc' => 'Objective-C',
'perl' => 'Perl',
'php' => 'PHP',
'puppet' => 'Puppet',
'rest' => 'reStructuredText',
'text' => 'Plain Text',
'python' => 'Python',
'rainbow' => 'Rainbow',
'remarkup' => 'Remarkup',
'ruby' => 'Ruby',
'xml' => 'XML',
'yaml' => 'YAML',
))
->setSummary(
pht('Set the language list which appears in dropdowns.'))
->setDescription(
pht(
'In places that we display a dropdown to syntax-highlight code, '.
'this is where that list is defined.')),
$this->newOption(
'syntax.filemap',
'wild',
array(
'@\.arcconfig$@' => 'js',
'@\.arclint$@' => 'js',
'@\.divinerconfig$@' => 'js',
))
->setSummary(
pht('Override what language files (based on filename) highlight as.'))
->setDescription(
pht(
'This is an override list of regular expressions which allows '.
'you to choose what language files are highlighted as. If your '.
'projects have certain rules about filenames or use unusual or '.
'ambiguous language extensions, you can create a mapping here. '.
'This is an ordered dictionary of regular expressions which will '.
'be tested against the filename. They should map to either an '.
'explicit language as a string value, or a numeric index into '.
'the captured groups as an integer.'))
->addExample('{"@\\.xyz$@": "php"}', pht('Highlight *.xyz as PHP.'))
->addExample(
'{"@/httpd\\.conf@": "apacheconf"}',
pht('Highlight httpd.conf as "apacheconf".'))
->addExample(
'{"@\\.([^.]+)\\.bak$@": 1}',
pht(
"Treat all '*.x.bak' file as '.x'. NOTE: We map to capturing group ".
"1 by specifying the mapping as '1'")),
$this->newOption(
'style.monospace',
'string',
'10px "Menlo", "Consolas", "Monaco", monospace')
->setLocked(true)
->setSummary(
pht('Default monospace font.'))
->setDescription(
pht(
"Set the default monospaced font style for users who haven't set ".
"a custom style.")),
$this->newOption(
'style.monospace.windows',
'string',
'11px "Menlo", "Consolas", "Monaco", monospace')
->setLocked(true)
->setSummary(
pht('Default monospace font for clients on Windows.'))
->setDescription(
pht(
"Set the default monospaced font style for users who haven't set ".
"a custom style and are using Windows.")),
);
}
}
diff --git a/src/docs/user/configuration/managing_caches.diviner b/src/docs/user/configuration/managing_caches.diviner
new file mode 100644
index 0000000000..53b48250ea
--- /dev/null
+++ b/src/docs/user/configuration/managing_caches.diviner
@@ -0,0 +1,47 @@
+@title Managing Caches
+@group config
+
+Discusses Phabricator caches and cache management.
+
+Overview
+========
+
+Phabricator uses various caches to improve performance, similar to the caches
+a web browser uses to improve web performance.
+
+In particular, blocks of text which are expensive to render (like formatted
+text and syntax highlighted code) are often cached after they're rendered for
+the first time. When they're rendered again, Phabricator can read the cache
+instead of recomputing the result.
+
+Because text is cached, you may continue to see the old result even after you
+make certain configuration changes which should affect it. The most common
+example of this is that if you enable syntax highlighting with Pygments, old
+diffs and pastes may not appear highlighted.
+
+You may also run into this issue if you modify existing Remarkup rules or
+develop new ones, or modify other parts of the code that run before the results
+are cached.
+
+Caches will naturally expire over time, so if they aren't causing a problem
+you can just ignore the out of date caches and they'll fix themselves
+eventually (usually within 30 days).
+
+If you don't want to wait, you can purge the caches. This will remove any
+cached data and force Phabricator to recompute the results.
+
+Purging Caches
+==============
+
+If you need to purge Phabricator's caches, you can use the CLI tool. Run it
+with the `--help` flag to see options:
+
+ phabricator/ $ ./bin/cache purge --help
+
+This tool can purge caches in a granular way, but it's normally easiest to
+just purge all of the caches:
+
+ phabricator/ $ ./bin/cache purge --purge-all
+
+You can purge caches safely. The data they contain can always be rebuilt from
+other data if Phabricator needs it.

File Metadata

Mime Type
text/x-diff
Expires
Thu, Jul 3, 8:22 PM (42 m, 19 s)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
166358
Default Alt Text
(8 KB)

Event Timeline

styx copyright 2020 sirocyl / ellie (kymkdd) / ncommander / styx contributors
Use of other names and brands is not intended to reflect a claim of, or right to, use the name or brand.
styx is an operating system using the Linux kernel and components, and "styx Linux" as a phrase does not reflect the inclusion of the Linux brand or trademark in the styx project.
Linux® is the registered trademark of Linus Torvalds in the U.S. and other countries.
Terms and Conditions (TODO: fix this!)