ispCP - Board - Support
ispcp tools not documented/commented - Printable Version

+- ispCP - Board - Support (http://www.isp-control.net/forum)
+-- Forum: ispCP Omega Development Area (/forum-1.html)
+--- Forum: Suggestions (/forum-2.html)
+--- Thread: ispcp tools not documented/commented (/thread-5884.html)



ispcp tools not documented/commented - Haeber - 03-02-2009 03:31 AM

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


RE: ispcp tools not documented/commented - joximu - 03-02-2009 08:09 AM

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


RE: ispcp tools not documented/commented - Haeber - 03-02-2009 12:04 PM

So what's the best way? Add comments or add a readme, or both? Should I open a ticket?

Best Regards
Haeber


RE: ispcp tools not documented/commented - Haeber - 03-02-2009 01:16 PM

I've added a comment in each file with changeset 1556, I used your suggestions.

Best Regards
Haeber


RE: ispcp tools not documented/commented - joximu - 03-02-2009 06:03 PM

This should do it - theese tools are mainly for devs and not end users...

Thanx

/J