Skip to Content.
Sympa Menu

sm-sorcery-bugs - [SM-Sorcery-Bugs] [Bug 15802] New: improvements for sorcery bashdoc documentation

sm-sorcery-bugs AT lists.ibiblio.org

Subject: Bugs for Sorcery are reported here

List archive

Chronological Thread  
  • From: bugzilla-daemon AT bugs.sourcemage.org
  • To: sm-sorcery-bugs AT lists.ibiblio.org
  • Subject: [SM-Sorcery-Bugs] [Bug 15802] New: improvements for sorcery bashdoc documentation
  • Date: 21 Aug 2010 19:39:00 -0000

http://bugs.sourcemage.org/show_bug.cgi?id=15802

Summary: improvements for sorcery bashdoc documentation
Product: Sorcery
Version: Untargetted future release
Platform: x86
OS/Version: Linux
Status: NEW
Severity: normal
Priority: P3
Component: Unknown
AssignedTo: sm-sorcery-bugs AT lists.ibiblio.org
ReportedBy: pyrobor AT ver.si


Created an attachment (id=7497)
--> (http://bugs.sourcemage.org/attachment.cgi?id=7497)
1st patch) automated add of empty headers to functions

Because I do some sorcery hacking from time to time bashdoc documentation is a
big help for me. So today I play around and improve it a bit. (I split the
changes in 3 patches for easier handling)

1st patch:
Changes were made with sed script. Script adds empty header to all the
functions that don't have head. This is good so functions are recognized as
functions and get linked in html docs. Thus make it really simple to follow
code. There were functions that were excluded (help, process_parameters,
strip_parameters, main, usage), because there are more of them named the same.
And that could bring problems to html links.

Script also changed:
"function_name() {" to "function function_name() {"
That was changed even for those functions that already had header from before.

2nd patch:
- Removed header of function help in cast,confmeld and scribe, since it only
brings the confusion in html.
- manual fixes of function headers that script in 1st patch didn't get. (fix
in
alter to function without () & fix libstate function remove_default_provider)

3rd patch:
Here is even more manual work. I edited the heads of the files so there are
processed by bashdoc. Here would be probably better to modify bashdoc to use
those "=head" tags somehow. Well I modified them to use tags with @ and also
added some html tags for nicer output.

--
Configure bugmail: http://bugs.sourcemage.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.




Archive powered by MHonArc 2.6.24.

Top of Page