Current time: 10-27-2021, 03:43 AM Hello There, Guest! (LoginRegister)


Post Reply 
ispcp tools not documented/commented
Author Message
Haeber Offline
Junior Member
*****
Dev Team

Posts: 136
Joined: Nov 2007
Reputation: 7
Post: #1
ispcp tools not documented/commented
The following tools / shell scripts don't have any documentation or comments:
  • tools/updateToPOT
  • tools/makemsgs

This makes it hard to understand/use.

Possible solutions:
  • add a readme file for more information about these tools
  • add comments into the files
  • do a rewrite from shell script to perl (easier for most users)

Best Regards
Haeber
(This post was last modified: 03-02-2009 03:59 AM by Haeber.)
03-02-2009 03:31 AM
Find all posts by this user Quote this message in a reply
joximu Offline
helper
*****
Moderators

Posts: 7,024
Joined: Jan 2007
Reputation: 92
Post: #2
RE: ispcp tools not documented/commented
Hi

makemsgs - seems to be a script which creates a ispCP.pot out of all strings used in the php files...

the other one - hm... - maybe update all po files with the new ispCP.pot (new strings...)

***
I also think a one liner comment would help but I also think its useless to rewrite this in perl...

/Joxi
03-02-2009 08:09 AM
Visit this user's website Find all posts by this user Quote this message in a reply
Haeber Offline
Junior Member
*****
Dev Team

Posts: 136
Joined: Nov 2007
Reputation: 7
Post: #3
RE: ispcp tools not documented/commented
So what's the best way? Add comments or add a readme, or both? Should I open a ticket?

Best Regards
Haeber
(This post was last modified: 03-02-2009 12:04 PM by Haeber.)
03-02-2009 12:04 PM
Find all posts by this user Quote this message in a reply
Haeber Offline
Junior Member
*****
Dev Team

Posts: 136
Joined: Nov 2007
Reputation: 7
Post: #4
RE: ispcp tools not documented/commented
I've added a comment in each file with changeset 1556, I used your suggestions.

Best Regards
Haeber
03-02-2009 01:16 PM
Find all posts by this user Quote this message in a reply
joximu Offline
helper
*****
Moderators

Posts: 7,024
Joined: Jan 2007
Reputation: 92
Post: #5
RE: ispcp tools not documented/commented
This should do it - theese tools are mainly for devs and not end users...

Thanx

/J
03-02-2009 06:03 PM
Visit this user's website Find all posts by this user Quote this message in a reply
Post Reply 


Forum Jump:


User(s) browsing this thread: 1 Guest(s)