mirror of
https://github.com/percona/percona-toolkit.git
synced 2026-02-27 02:00:57 +08:00
Add util/write-dev-docs, util/extract-package, and docs/dev/.
This commit is contained in:
Daniel Nichter
113
config/NaturalDocs/Languages.txt
Normal file
113
config/NaturalDocs/Languages.txt
Normal file
@@ -0,0 +1,113 @@
|
||||
Format: 1.52
|
||||
|
||||
# This is the Natural Docs languages file for this project. If you change
|
||||
# anything here, it will apply to THIS PROJECT ONLY. If you'd like to change
|
||||
# something for all your projects, edit the Languages.txt in Natural Docs'
|
||||
# Config directory instead.
|
||||
|
||||
|
||||
# You can prevent certain file extensions from being scanned like this:
|
||||
# Ignore Extensions: [extension] [extension] ...
|
||||
|
||||
|
||||
#-------------------------------------------------------------------------------
|
||||
# SYNTAX:
|
||||
#
|
||||
# Unlike other Natural Docs configuration files, in this file all comments
|
||||
# MUST be alone on a line. Some languages deal with the # character, so you
|
||||
# cannot put comments on the same line as content.
|
||||
#
|
||||
# Also, all lists are separated with spaces, not commas, again because some
|
||||
# languages may need to use them.
|
||||
#
|
||||
# Language: [name]
|
||||
# Alter Language: [name]
|
||||
# Defines a new language or alters an existing one. Its name can use any
|
||||
# characters. If any of the properties below have an add/replace form, you
|
||||
# must use that when using Alter Language.
|
||||
#
|
||||
# The language Shebang Script is special. It's entry is only used for
|
||||
# extensions, and files with those extensions have their shebang (#!) lines
|
||||
# read to determine the real language of the file. Extensionless files are
|
||||
# always treated this way.
|
||||
#
|
||||
# The language Text File is also special. It's treated as one big comment
|
||||
# so you can put Natural Docs content in them without special symbols. Also,
|
||||
# if you don't specify a package separator, ignored prefixes, or enum value
|
||||
# behavior, it will copy those settings from the language that is used most
|
||||
# in the source tree.
|
||||
#
|
||||
# Extensions: [extension] [extension] ...
|
||||
# [Add/Replace] Extensions: [extension] [extension] ...
|
||||
# Defines the file extensions of the language's source files. You can
|
||||
# redefine extensions found in the main languages file. You can use * to
|
||||
# mean any undefined extension.
|
||||
#
|
||||
# Shebang Strings: [string] [string] ...
|
||||
# [Add/Replace] Shebang Strings: [string] [string] ...
|
||||
# Defines a list of strings that can appear in the shebang (#!) line to
|
||||
# designate that it's part of the language. You can redefine strings found
|
||||
# in the main languages file.
|
||||
#
|
||||
# Ignore Prefixes in Index: [prefix] [prefix] ...
|
||||
# [Add/Replace] Ignored Prefixes in Index: [prefix] [prefix] ...
|
||||
#
|
||||
# Ignore [Topic Type] Prefixes in Index: [prefix] [prefix] ...
|
||||
# [Add/Replace] Ignored [Topic Type] Prefixes in Index: [prefix] [prefix] ...
|
||||
# Specifies prefixes that should be ignored when sorting symbols in an
|
||||
# index. Can be specified in general or for a specific topic type.
|
||||
#
|
||||
#------------------------------------------------------------------------------
|
||||
# For basic language support only:
|
||||
#
|
||||
# Line Comments: [symbol] [symbol] ...
|
||||
# Defines a space-separated list of symbols that are used for line comments,
|
||||
# if any.
|
||||
#
|
||||
# Block Comments: [opening sym] [closing sym] [opening sym] [closing sym] ...
|
||||
# Defines a space-separated list of symbol pairs that are used for block
|
||||
# comments, if any.
|
||||
#
|
||||
# Package Separator: [symbol]
|
||||
# Defines the default package separator symbol. The default is a dot.
|
||||
#
|
||||
# [Topic Type] Prototype Enders: [symbol] [symbol] ...
|
||||
# When defined, Natural Docs will attempt to get a prototype from the code
|
||||
# immediately following the topic type. It stops when it reaches one of
|
||||
# these symbols. Use \n for line breaks.
|
||||
#
|
||||
# Line Extender: [symbol]
|
||||
# Defines the symbol that allows a prototype to span multiple lines if
|
||||
# normally a line break would end it.
|
||||
#
|
||||
# Enum Values: [global|under type|under parent]
|
||||
# Defines how enum values are referenced. The default is global.
|
||||
# global - Values are always global, referenced as 'value'.
|
||||
# under type - Values are under the enum type, referenced as
|
||||
# 'package.enum.value'.
|
||||
# under parent - Values are under the enum's parent, referenced as
|
||||
# 'package.value'.
|
||||
#
|
||||
# Perl Package: [perl package]
|
||||
# Specifies the Perl package used to fine-tune the language behavior in ways
|
||||
# too complex to do in this file.
|
||||
#
|
||||
#------------------------------------------------------------------------------
|
||||
# For full language support only:
|
||||
#
|
||||
# Full Language Support: [perl package]
|
||||
# Specifies the Perl package that has the parsing routines necessary for full
|
||||
# language support.
|
||||
#
|
||||
#-------------------------------------------------------------------------------
|
||||
|
||||
# The following languages are defined in the main file, if you'd like to alter
|
||||
# them:
|
||||
#
|
||||
# Text File, Shebang Script, C/C++, C#, Java, JavaScript, Perl, Python,
|
||||
# PHP, SQL, Visual Basic, Pascal, Assembly, Ada, Tcl, Ruby, Makefile,
|
||||
# ActionScript, ColdFusion, R, Fortran
|
||||
|
||||
# If you add a language that you think would be useful to other developers
|
||||
# and should be included in Natural Docs by default, please e-mail it to
|
||||
# languages [at] naturaldocs [dot] org.
|
||||
174
config/NaturalDocs/Menu.txt
Normal file
174
config/NaturalDocs/Menu.txt
Normal file
@@ -0,0 +1,174 @@
|
||||
Format: 1.52
|
||||
|
||||
|
||||
# You can add a title and sub-title to your menu like this:
|
||||
# Title: [project name]
|
||||
# SubTitle: [subtitle]
|
||||
|
||||
# You can add a footer to your documentation like this:
|
||||
# Footer: [text]
|
||||
# If you want to add a copyright notice, this would be the place to do it.
|
||||
|
||||
# You can add a timestamp to your documentation like one of these:
|
||||
# Timestamp: Generated on month day, year
|
||||
# Timestamp: Updated mm/dd/yyyy
|
||||
# Timestamp: Last updated mon day
|
||||
#
|
||||
# m - One or two digit month. January is "1"
|
||||
# mm - Always two digit month. January is "01"
|
||||
# mon - Short month word. January is "Jan"
|
||||
# month - Long month word. January is "January"
|
||||
# d - One or two digit day. 1 is "1"
|
||||
# dd - Always two digit day. 1 is "01"
|
||||
# day - Day with letter extension. 1 is "1st"
|
||||
# yy - Two digit year. 2006 is "06"
|
||||
# yyyy - Four digit year. 2006 is "2006"
|
||||
# year - Four digit year. 2006 is "2006"
|
||||
|
||||
|
||||
# --------------------------------------------------------------------------
|
||||
#
|
||||
# Cut and paste the lines below to change the order in which your files
|
||||
# appear on the menu. Don't worry about adding or removing files, Natural
|
||||
# Docs will take care of that.
|
||||
#
|
||||
# You can further organize the menu by grouping the entries. Add a
|
||||
# "Group: [name] {" line to start a group, and add a "}" to end it.
|
||||
#
|
||||
# You can add text and web links to the menu by adding "Text: [text]" and
|
||||
# "Link: [name] ([URL])" lines, respectively.
|
||||
#
|
||||
# The formatting and comments are auto-generated, so don't worry about
|
||||
# neatness when editing the file. Natural Docs will clean it up the next
|
||||
# time it is run. When working with groups, just deal with the braces and
|
||||
# forget about the indentation and comments.
|
||||
#
|
||||
# --------------------------------------------------------------------------
|
||||
|
||||
|
||||
Group: Modules {
|
||||
|
||||
File: Advisor (modules/Advisor.pm)
|
||||
File: AdvisorRules (modules/AdvisorRules.pm)
|
||||
File: BinaryLogParser (modules/BinaryLogParser.pm)
|
||||
File: ChangeHandler (modules/ChangeHandler.pm)
|
||||
File: CompareQueryTimes (modules/CompareQueryTimes.pm)
|
||||
File: CompareResults (modules/CompareResults.pm)
|
||||
File: CompareTableStructs (modules/CompareTableStructs.pm)
|
||||
File: CompareWarnings (modules/CompareWarnings.pm)
|
||||
File: CopyRowsInsertSelect (modules/CopyRowsInsertSelect.pm)
|
||||
File: Daemon (modules/Daemon.pm)
|
||||
File: DSNParser (modules/DSNParser.pm)
|
||||
File: DuplicateKeyFinder (modules/DuplicateKeyFinder.pm)
|
||||
File: EventAggregator (modules/EventAggregator.pm)
|
||||
File: EventTimeline (modules/EventTimeline.pm)
|
||||
File: ExecutionThrottler (modules/ExecutionThrottler.pm)
|
||||
File: ExplainAnalyzer (modules/ExplainAnalyzer.pm)
|
||||
File: FileIterator (modules/FileIterator.pm)
|
||||
File: ForeignKeyIterator (modules/ForeignKeyIterator.pm)
|
||||
File: GeneralLogParser (modules/GeneralLogParser.pm)
|
||||
File: HTTPProtocolParser (modules/HTTPProtocolParser.pm)
|
||||
File: IndexUsage (modules/IndexUsage.pm)
|
||||
File: InnoDBStatusParser (modules/InnoDBStatusParser.pm)
|
||||
File: KeySize (modules/KeySize.pm)
|
||||
File: LogSplitter (modules/LogSplitter.pm)
|
||||
File: MaatkitTest (modules/MaatkitTest.pm)
|
||||
File: MasterSlave (modules/MasterSlave.pm)
|
||||
File: MemcachedEvent (modules/MemcachedEvent.pm)
|
||||
File: MemcachedProtocolParser (modules/MemcachedProtocolParser.pm)
|
||||
File: MockSth (modules/MockSth.pm)
|
||||
File: MockSync (modules/MockSync.pm)
|
||||
File: MockSyncStream (modules/MockSyncStream.pm)
|
||||
File: MySQLConfig (modules/MySQLConfig.pm)
|
||||
File: MySQLConfigComparer (modules/MySQLConfigComparer.pm)
|
||||
File: MySQLDump (modules/MySQLDump.pm)
|
||||
File: MySQLProtocolParser (modules/MySQLProtocolParser.pm)
|
||||
File: OptionParser (modules/OptionParser.pm)
|
||||
File: OSCCaptureSync (modules/OSCCaptureSync.pm)
|
||||
File: Outfile (modules/Outfile.pm)
|
||||
File: PgLogParser (modules/PgLogParser.pm)
|
||||
File: Pipeline (modules/Pipeline.pm)
|
||||
File: PodParser (modules/PodParser.pm)
|
||||
File: Processlist (modules/Processlist.pm)
|
||||
File: ProcesslistAggregator (modules/ProcesslistAggregator.pm)
|
||||
File: Progress (modules/Progress.pm)
|
||||
File: ProtocolParser (modules/ProtocolParser.pm)
|
||||
File: QueryAdvisorRules (modules/QueryAdvisorRules.pm)
|
||||
File: QueryParser (modules/QueryParser.pm)
|
||||
File: QueryReportFormatter (modules/QueryReportFormatter.pm)
|
||||
File: QueryReview (modules/QueryReview.pm)
|
||||
File: QueryRewriter (modules/QueryRewriter.pm)
|
||||
File: Quoter (modules/Quoter.pm)
|
||||
File: ReportFormatter (modules/ReportFormatter.pm)
|
||||
File: Retry (modules/Retry.pm)
|
||||
File: RowDiff (modules/RowDiff.pm)
|
||||
File: Runtime (modules/Runtime.pm)
|
||||
File: Sandbox (modules/Sandbox.pm)
|
||||
File: Schema (modules/Schema.pm)
|
||||
File: SchemaIterator (modules/SchemaIterator.pm)
|
||||
File: SimpleTCPDumpParser (modules/SimpleTCPDumpParser.pm)
|
||||
File: SlowLogParser (modules/SlowLogParser.pm)
|
||||
File: SlowLogWriter (modules/SlowLogWriter.pm)
|
||||
File: SQLParser (modules/SQLParser.pm)
|
||||
File: SysLogParser (modules/SysLogParser.pm)
|
||||
File: TableChecksum (modules/TableChecksum.pm)
|
||||
File: TableChunker (modules/TableChunker.pm)
|
||||
File: TableNibbler (modules/TableNibbler.pm)
|
||||
File: TableParser (modules/TableParser.pm)
|
||||
File: TableSyncChunk (modules/TableSyncChunk.pm)
|
||||
File: TableSyncer (modules/TableSyncer.pm)
|
||||
File: TableSyncGroupBy (modules/TableSyncGroupBy.pm)
|
||||
File: TableSyncNibble (modules/TableSyncNibble.pm)
|
||||
File: TableSyncStream (modules/TableSyncStream.pm)
|
||||
File: TableUsage (modules/TableUsage.pm)
|
||||
File: TcpdumpParser (modules/TcpdumpParser.pm)
|
||||
File: TCPRequestAggregator (modules/TCPRequestAggregator.pm)
|
||||
File: TextResultSetParser (modules/TextResultSetParser.pm)
|
||||
File: TimeSeriesTrender (modules/TimeSeriesTrender.pm)
|
||||
File: Transformers (modules/Transformers.pm)
|
||||
File: UpgradeReportFormatter (modules/UpgradeReportFormatter.pm)
|
||||
File: VariableAdvisorRules (modules/VariableAdvisorRules.pm)
|
||||
File: VersionParser (modules/VersionParser.pm)
|
||||
} # Group: Modules
|
||||
|
||||
Group: Tools {
|
||||
|
||||
File: pt_archiver (tools/pt-archiver.pm)
|
||||
File: pt_config_diff (tools/pt-config-diff.pm)
|
||||
File: pt_deadlock_logger (tools/pt-deadlock-logger.pm)
|
||||
File: pt_duplicate_key_checker (tools/pt-duplicate-key-checker.pm)
|
||||
File: pt_fifo_split (tools/pt-fifo-split.pm)
|
||||
File: pt_find (tools/pt-find.pm)
|
||||
File: pt_fk_error_logger (tools/pt-fk-error-logger.pm)
|
||||
File: pt_heartbeat (tools/pt-heartbeat.pm)
|
||||
File: pt_index_usage (tools/pt-index-usage.pm)
|
||||
File: pt_kill (tools/pt-kill.pm)
|
||||
File: pt_log_player (tools/pt-log-player.pm)
|
||||
File: pt_online_schema_change (tools/pt-online-schema-change.pm)
|
||||
File: pt_profile_compact (tools/pt-profile-compact.pm)
|
||||
File: pt_query_advisor (tools/pt-query-advisor.pm)
|
||||
File: pt_query_digest (tools/pt-query-digest.pm)
|
||||
File: pt_query_profiler (tools/pt-query-profiler.pm)
|
||||
File: pt_schema_advisor (tools/pt-schema-advisor.pm)
|
||||
File: pt_show_grants (tools/pt-show-grants.pm)
|
||||
File: pt_slave_delay (tools/pt-slave-delay.pm)
|
||||
File: pt_slave_find (tools/pt-slave-find.pm)
|
||||
File: pt_slave_restart (tools/pt-slave-restart.pm)
|
||||
File: pt_table_checksum (tools/pt-table-checksum.pm)
|
||||
File: pt_table_sync (tools/pt-table-sync.pm)
|
||||
File: pt_table_usage (tools/pt-table-usage.pm)
|
||||
File: pt_tcp_model (tools/pt-tcp-model.pm)
|
||||
File: pt_trend (tools/pt-trend.pm)
|
||||
File: pt_upgrade (tools/pt-upgrade.pm)
|
||||
File: pt_variable_advisor (tools/pt-variable-advisor.pm)
|
||||
File: pt_visual_explain (tools/pt-visual-explain.pm)
|
||||
} # Group: Tools
|
||||
|
||||
Group: Index {
|
||||
|
||||
Index: Everything
|
||||
Class Index: Classes
|
||||
Function Index: Functions
|
||||
Variable Index: Variables
|
||||
} # Group: Index
|
||||
|
||||
81
config/NaturalDocs/Topics.txt
Normal file
81
config/NaturalDocs/Topics.txt
Normal file
@@ -0,0 +1,81 @@
|
||||
Format: 1.52
|
||||
|
||||
# This is the Natural Docs topics file for this project. If you change anything
|
||||
# here, it will apply to THIS PROJECT ONLY. If you'd like to change something
|
||||
# for all your projects, edit the Topics.txt in Natural Docs' Config directory
|
||||
# instead.
|
||||
|
||||
|
||||
# If you'd like to prevent keywords from being recognized by Natural Docs, you
|
||||
# can do it like this:
|
||||
# Ignore Keywords: [keyword], [keyword], ...
|
||||
#
|
||||
# Or you can use the list syntax like how they are defined:
|
||||
# Ignore Keywords:
|
||||
# [keyword]
|
||||
# [keyword], [plural keyword]
|
||||
# ...
|
||||
|
||||
|
||||
#-------------------------------------------------------------------------------
|
||||
# SYNTAX:
|
||||
#
|
||||
# Topic Type: [name]
|
||||
# Alter Topic Type: [name]
|
||||
# Creates a new topic type or alters one from the main file. Each type gets
|
||||
# its own index and behavior settings. Its name can have letters, numbers,
|
||||
# spaces, and these charaters: - / . '
|
||||
#
|
||||
# Plural: [name]
|
||||
# Sets the plural name of the topic type, if different.
|
||||
#
|
||||
# Keywords:
|
||||
# [keyword]
|
||||
# [keyword], [plural keyword]
|
||||
# ...
|
||||
# Defines or adds to the list of keywords for the topic type. They may only
|
||||
# contain letters, numbers, and spaces and are not case sensitive. Plural
|
||||
# keywords are used for list topics. You can redefine keywords found in the
|
||||
# main topics file.
|
||||
#
|
||||
# Index: [yes|no]
|
||||
# Whether the topics get their own index. Defaults to yes. Everything is
|
||||
# included in the general index regardless of this setting.
|
||||
#
|
||||
# Scope: [normal|start|end|always global]
|
||||
# How the topics affects scope. Defaults to normal.
|
||||
# normal - Topics stay within the current scope.
|
||||
# start - Topics start a new scope for all the topics beneath it,
|
||||
# like class topics.
|
||||
# end - Topics reset the scope back to global for all the topics
|
||||
# beneath it.
|
||||
# always global - Topics are defined as global, but do not change the scope
|
||||
# for any other topics.
|
||||
#
|
||||
# Class Hierarchy: [yes|no]
|
||||
# Whether the topics are part of the class hierarchy. Defaults to no.
|
||||
#
|
||||
# Page Title If First: [yes|no]
|
||||
# Whether the topic's title becomes the page title if it's the first one in
|
||||
# a file. Defaults to no.
|
||||
#
|
||||
# Break Lists: [yes|no]
|
||||
# Whether list topics should be broken into individual topics in the output.
|
||||
# Defaults to no.
|
||||
#
|
||||
# Can Group With: [type], [type], ...
|
||||
# Defines a list of topic types that this one can possibly be grouped with.
|
||||
# Defaults to none.
|
||||
#-------------------------------------------------------------------------------
|
||||
|
||||
# The following topics are defined in the main file, if you'd like to alter
|
||||
# their behavior or add keywords:
|
||||
#
|
||||
# Generic, Class, Interface, Section, File, Group, Function, Variable,
|
||||
# Property, Type, Constant, Enumeration, Event, Delegate, Macro,
|
||||
# Database, Database Table, Database View, Database Index, Database
|
||||
# Cursor, Database Trigger, Cookie, Build Target
|
||||
|
||||
# If you add something that you think would be useful to other developers
|
||||
# and should be included in Natural Docs by default, please e-mail it to
|
||||
# topics [at] naturaldocs [dot] org.
|
||||
Reference in New Issue
Block a user