Skip to content

Commit

Permalink
Cleaning scripts in 'tools/'.
Browse files Browse the repository at this point in the history
Fixed spelling/grammar for most output messages.

Updated references to 'make sql' to 'make server'.

Signed-off-by: Euphy <euphy.raliel@rathena.org>
  • Loading branch information
euphyy committed Jan 5, 2015
1 parent 357aa04 commit 8897ad7
Show file tree
Hide file tree
Showing 10 changed files with 157 additions and 153 deletions.
6 changes: 3 additions & 3 deletions Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -97,9 +97,9 @@ help:
@echo "'all' - builds all the above targets"
@echo "'server' - builds servers (targets 'common' 'login' 'char' 'map' and 'import')"
@echo "'clean' - cleans builds and objects"
@echo "'install' - run installer wich setup rathena in /opt/"
@echo "'bin-clean' - delete binary installed"
@echo "'uninstall' - run uninstaller wich erase all install change"
@echo "'install' - run installer which sets up rathena in /opt/"
@echo "'bin-clean' - deletes installed binaries"
@echo "'uninstall' - run uninstaller which erases all installation changes"
@echo "'help' - outputs this message"

needs_mysql:
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ Build Status: [![Build Status](https://travis-ci.org/rathena/rathena.png?branch=

Table of Contents
---------
* 1 What is rAthena?
* 2 Prerequisites
* 3 Installation
* 4 Troubleshooting
* 5 Helpful Links
* 6 More Documentation
1. What is rAthena?
2. Prerequisites
3. Installation
4. Troubleshooting
5. Helpful Links
6. More Documentation

1. What is rAthena?
---------
Expand Down Expand Up @@ -90,7 +90,7 @@ relevant to your Operation System, please refer to the Wiki (links at the end of
mysql --user=root -p rathena_rag < trunk/sql-files/main.sql (and others)
* Configure and compile:

./configure && make clean && make sql
./configure && make clean && make server
* When you're ready, start the servers:

./athena-start start
Expand Down
4 changes: 2 additions & 2 deletions README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
//===== By: ==================================================
//= rAthena Dev Team
//===== Last Updated: ========================================
//= 20131112
//= 20150104
//===== Description: =========================================
//= Basic information and installation guide with links to
//= various forum posts and Wiki articles.
Expand Down Expand Up @@ -95,7 +95,7 @@ Linux
* Insert SQL files:
mysql --user=root -p rathena_rag < trunk/sql-files/main.sql (and others)
* Configure and compile:
./configure && make clean && make sql
./configure && make clean && make server
* When you're ready, start the servers:
./athena-start start

Expand Down
21 changes: 11 additions & 10 deletions tools/build_doc.pl
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
#!/usr/bin/perl
# building documentation using doxygen and updation versionning number
# Documentation Builder
# Builds documentation using doxygen and updates version number.
use strict;
use File::Basename;
use Getopt::Long;
Expand All @@ -19,25 +20,25 @@
sub GetArgs {
GetOptions(
'doxyconf=s' => \$sDocFile, #specify the doxygen configuration file
'outdir=s' => \$outputdir, #specify in wich folder to build the documentation
'ignorechk=s' => \$sIgnChk, #Target (wich setup to run)
'outdir=s' => \$outputdir, #specify in which folder to build the documentation
'ignorechk=s' => \$sIgnChk, #Target (which setup to run)
'forcebuild=i' => \$sForceBuild, #should we chk if all doc are linked to a src ?
'noupd=i' => \$sNoUpd, #prevent altering doxygen conf
'help!' => \$sHelp,
) or $sHelp=1; #display help if invalid option

if( $sHelp ) {
print "Incorect option specified, available option are:\n"
."\t --doxyconf filename => specify wich doxygen configuration to use\n"
."\t --outdir path => specify in wich path to build doxygen documentation\n"
."\t --doxyconf filename => specify which doxygen configuration to use\n"
."\t --outdir path => specify in which path to build doxygen documentation\n"
."\t --forcebuild=0|1 => should we force building of documentation even if same git detected ?\n"
."\t --noupd=0|1 => should we skip producing a new doxyconf for version ?\n"
."\t --ignorechk => target (specify wich check to ignore [$sValidTarget])\n";
."\t --ignorechk => target (specify which check to ignore [$sValidTarget])\n";
exit;
}
if($sIgnChk && !($sIgnChk =~ /$sValidTarget/i)){
print "Incorect ignorechk target specified, available target are:\n"
."\t --ignorechk => target (specify wich check to ignore [(default)$sValidTarget])\n";
print "Incorect ignorechk target specified. Available targets:\n"
."\t --ignorechk => target (specify which check to ignore [(default)$sValidTarget])\n";
exit;
}
}
Expand Down Expand Up @@ -76,7 +77,7 @@ sub DoxygenChk {
chomp($doxyversion); #remove newline
print "doxyversion = [ $doxyversion ]\n";
if($doxyversion eq ""){
die "Please install doxygen to proceed";
die "Please install doxygen to proceed.";
}
close PIPE;
return $doxyversion;
Expand All @@ -94,7 +95,7 @@ sub GitChk {
chomp($gitversion);
print "git = [ $gitversion ]\n";
if($gitversion eq ""){
die "Please install git to proceed";
die "Please install git to proceed.";
}
close PIPE;
return $gitversion;
Expand Down
28 changes: 14 additions & 14 deletions tools/check-doc.pl
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/perl
# checking-doc original script by trojal
# modified by lighta
# Documentation Checker
# by trojal (modified by lighta)

use strict;
use File::Basename;
Expand Down Expand Up @@ -46,12 +46,12 @@ sub GetArgs {
exit;
}
unless($sTarget =~ /$sValidTarget/i){
print "Incorrect target specified, available target is:\n"
print "Incorrect target specified. Available targets:\n"
."\t --target => target (specify wich check to run [(default)$sValidTarget])\n";

This comment has been minimized.

Copy link
@Lemongrass3110

Lemongrass3110 Jan 5, 2015

Member

which

exit;
}
unless($sCmd =~ /$sValidCmd/i){
print "Incorrect command specified, available command is:\n"
print "Incorrect command specified. Available commands:\n"
."\t --cmd => cmd (specify wich command to run [(default)$sValidCmd])\n";

This comment has been minimized.

Copy link
@Lemongrass3110

Lemongrass3110 Jan 5, 2015

Member

which

exit;
}
Expand Down Expand Up @@ -97,7 +97,7 @@ sub Script_GetCmd {
my @aDef_sct = ();
foreach my $sSct_srcf (@aSct_src){
unless(open FILE_SRC, "<$sSct_srcf") {
print "couldn't open file $sSct_srcf \n";
print "Couldn't open file '$sSct_srcf'.\n";
next;
}
while(<FILE_SRC>){
Expand Down Expand Up @@ -128,7 +128,7 @@ sub Script_GetCmd {

foreach my $sSct_docf (@aSct_docf){
unless(open FILE_DOC, "$sSct_docf"){
print "couldn't open file $sSct_docf \n";
print "Couldn't open file '$sSct_docf'.\n";
next;
}
while(<FILE_DOC>){
Expand Down Expand Up @@ -157,18 +157,18 @@ sub Script_GetCmd {
}
print "}\n\n";
}
else { print "All script command in Src are documented, no issues found\n"; }
else { print "All script commands in src are documented, no issues found.\n"; }

if($sLeftOverChk){
my $raLeftover_sct = Chk(\@aDoc_sct,$raDef_sct); #we just inverse the chk for leftover
if(scalar(@$raLeftover_sct)){
print "Those script command was found in doc but no source associated, leftover ? :{\n";
print "These script commands were found in doc with no associated source:{\n";
foreach(@$raLeftover_sct){
print "\t$_ \n";
}
print "}\n\n";
}
else { print "All script command in documentation match a source BUILDIN, no leftover found\n"; }
else { print "All script commands in documentation match a source BUILDIN, no leftovers found.\n"; }
}
}

Expand All @@ -177,7 +177,7 @@ sub Atc_GetCmd {
my @aDef_act = ();
foreach my $sAct_srcf (@aAct_src){
unless(open FILE_SRC, "<$sAct_srcf"){
print "couldn't open file $sAct_srcf \n";
print "Couldn't open file '$sAct_srcf'.\n";
next;
}
while(<FILE_SRC>){
Expand Down Expand Up @@ -210,7 +210,7 @@ sub Atc_GetCmd {

foreach my $sAct_docf (@aAct_docf){
unless(open FILE_DOC, "$sAct_docf"){
print "couldn't open file $sAct_docf \n";
print "Couldn't open file '$sAct_docf'.\n";
next;
}
while(<FILE_DOC>){
Expand All @@ -235,17 +235,17 @@ sub Atc_GetCmd {
}
print "}\n\n";
}
else { print "All atcommand in Src are documented, no issues found\n"; }
else { print "All atcommands in src are documented, no issues found.\n"; }

if($sLeftOverChk){
my $raLeftover_sct = Chk(\@aDoc_act,$raDef_act); #we just inverse the chk for leftover
if(scalar(@$raLeftover_sct)){
print "Those atcommands were found in doc but no source associated, leftover ? : {\n";
print "These atcommands were found in doc with no associated source: {\n";
foreach(@$raLeftover_sct){
print "\t$_ \n";
}
print "}\n\n";
}
else { print "All atcommands in documentation match a source ATCMD, no leftover found\n"; }
else { print "All atcommands in documentation match a source ATCMD, no leftovers found.\n"; }
}
}

0 comments on commit 8897ad7

Please sign in to comment.