Skip to content

Commit a24db8f

Browse files
leonardoAnjos16leonardoAnjos16
committed
documentation: update help output in README
1 parent fa84603 commit a24db8f

1 file changed

Lines changed: 101 additions & 30 deletions

File tree

‎README.md‎

Lines changed: 101 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -85,36 +85,107 @@ usage: miningframework [options] [input] [output]
8585
the Mining Framework take an input csv file and a name for the output dir
8686
(default: output)
8787
Options:
88-
-a,--access-key <access key> Specify the access key of the git account
89-
for when the analysis needs user access to
90-
GitHub
91-
-e, --extension <extension> Specify the file extension that should be
92-
used in the analysis (e.g. .rb, .ts, .java,
93-
.cpp. Default: .java)
94-
-h,--help Show help for executing commands
95-
-i,--injector <class> Specify the class of the dependency
96-
injector (Must provide full name, default
97-
injectors.StaticAnalysisConflictsDetection
98-
Module)
99-
-k,--keep-projects Specify that cloned projects must be kept
100-
after the analysis (those are kept in
101-
clonedRepositories/ )
102-
-l,--language-separators <'separators'> Specify the language separators that should
103-
be used in the analysis. Required for (and
104-
only considered when) running studies with
105-
the CSDiff tool. Default: '{ } ( ) ; ,'
106-
-log,--log-level <log level Specify the minimum log level: (OFF, FATAL,
107-
ERROR, WARN, INFO, DEBUG, TRACE, ALL).
108-
Default: "INFO"
109-
-p,--push <link> Specify a git repository to upload the
110-
output in the end of the analysis (format
111-
https://github.com/<owner>/<name>
112-
-s,--since <date> Use commits more recent than a specific
113-
date (format DD/MM/YYY)
114-
-t,--threads <threads> Number of cores used in analysis (default:
115-
1)
116-
-u,--until <date> Use commits older than a specific
117-
date(format DD/MM/YYYY)
88+
-a,--access-key <access key> Specify the
89+
access key of
90+
the git
91+
account for
92+
when the
93+
analysis needs
94+
user access to
95+
GitHub
96+
-e,--extension <file extenson> Specify the
97+
file extension
98+
that should be
99+
used in the
100+
analysis (e.g.
101+
.rb, .ts,
102+
.java, .cpp.
103+
Default:
104+
.java)
105+
-h,--help Show help for
106+
executing
107+
commands
108+
-i,--injector <class> Specify the
109+
class of the
110+
dependency
111+
injector (Must
112+
provide full
113+
name, default
114+
injectors.Stat
115+
icAnalysisConf
116+
lictsDetection
117+
Module)
118+
-k,--keep-projects Specify that
119+
cloned
120+
projects must
121+
be kept after
122+
the analysis
123+
(those are
124+
kept in
125+
clonedReposito
126+
ries/ )
127+
-l,--language-separators <language syntactic separators> Specify the
128+
language
129+
separators
130+
that should be
131+
used in the
132+
analysis.
133+
Required for
134+
(and only
135+
considered
136+
when) running
137+
studies with
138+
the CSDiff
139+
tool. Default:
140+
"{ } ( ) ; ,"
141+
-log,--log-level <log level> Specify the
142+
minimum log
143+
level: (OFF,
144+
FATAL, ERROR,
145+
WARN, INFO,
146+
DEBUG, TRACE,
147+
ALL). Default:
148+
"INFO"
149+
-m,--max-commits-per-project <commits> Maximum number
150+
of commits to
151+
use for each
152+
project.
153+
Commits will
154+
be selected
155+
randomly,
156+
according to
157+
provided
158+
random seed
159+
-p,--push <link> Specify a git
160+
repository to
161+
upload the
162+
output in the
163+
end of the
164+
analysis
165+
(format
166+
https://github
167+
.com/<owner>/<
168+
name>
169+
-r,--random-seed <seed> Random seed
170+
used for
171+
shuffling
172+
merge commits
173+
array
174+
-s,--since <date> Use commits
175+
more recent
176+
than a
177+
specific date
178+
(format
179+
YYYY-MM-DD)
180+
-t,--threads <threads> Number of
181+
cores used in
182+
analysis
183+
(default: 1)
184+
-u,--until <date> Use commits
185+
older than a
186+
specific
187+
date(format
188+
YYYY-MM-DD)
118189
```
119190

120191

0 commit comments

Comments
 (0)