gitinspector/help.py

57 lines
2.7 KiB
Python

# coding: utf-8
#
# Copyright © 2012 Ejwa Software. All rights reserved.
#
# This file is part of gitinspector.
#
# gitinspector is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# gitinspector is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with gitinspector. If not, see <http://www.gnu.org/licenses/>.
"""Usage: {0} [OPTION]... [DIRECTORY]
List information about the repository in DIRECTORY. If no directory is
specified, the current directory is used. If multiple directories are
given, information will be fetched from the last directory specified.
Mandatory arguments to long options are mandatory for short options too.
-c, --checkout-missing try to checkout any missing files
-f, --file-types=EXTENSIONS a comma separated list of file extensions to
include when computing statistics. The
default extensions used are:
{1}
-H, --hard look harder for duplicates of rows and files
-l, --list-file-types list all the file extensions available in the
current branch of the repository
-T, --timeline show commit timeline, including author names
--tda367 show statistics and information in a way that
is formatted for the course TDA367/DIT211
this is currently the same as -lTw, but
will later include some additional searches
for things such as documentation (RAD/SDD)
-w show all statistical information in weeks
instead of in months
-h, --help display this help and exit
--version output version information and exit
gitinspector will filter statistics to only include commits that modify,
add or remove one of the specified extensions, see -f or --file-types for
more information.
gitinspector requires that the git executable is available in your PATH.
Report gitinspector bugs to gitinspector@ejwa.se."""
from extensions import __default_extensions__
import sys
def output():
print __doc__.format(sys.argv[0], ",".join(__default_extensions__))