DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG· RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT <http://issues.apache.org/bugzilla/show_bug.cgi?id=33281>. ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND· INSERTED IN THE BUG DATABASE.
http://issues.apache.org/bugzilla/show_bug.cgi?id=33281 Summary: Clarify project, target, property, classpath and arg documentation Product: Ant Version: 1.6.2 Platform: Sun URL: http://http://ant.apache.org/manual/using.html#arg OS/Version: Solaris Status: NEW Severity: normal Priority: P2 Component: Documentation AssignedTo: [EMAIL PROTECTED] ReportedBy: [EMAIL PROTECTED] http://ant.apache.org/manual/using.html#arg Two suggestions for this page: SUGGESTION 1: The arguments section says: <arg value="-l -a"/> is a single command-line argument containing a space character. This is a confusing example, as it appears (to anyone who knows Unix) like two command line options (% ls -l -a), which implies it is two arguments, not one. (I had tried to do <arg value="-d docs"> for javadoc, which causes an error. I thought of this as one argument with two parameters.) The other problem is that this example is identical to the next one, which is described in a contradictory fashion as "two separate command-line arguments". It would be a lot clearer to use a string that contains a space and doesn't look like two arguments. Here's one that is well-known to many: <arg value="Program Files"> SUGGESTION 2: This concerns <project>, <target>, <property>, <classpath>, and <arg> Each of the main sections on this page do not show the element prominently in the first sentence (or at all, for project). This is a reference guide after all, and who knows what a "project" is if you don't define its syntax? Examples are not definitive. The first few times I visited this page, I was unsure if this was the definitive page or not. This makes the docs quite hard to understand or search through and find these elements. I think it would be sufficient to add "<target>" rather than "<target attrib=value>". If I were doing this, in addition to a reference in the first sentence, for prominence and clarity, I would also add the syntax ahead of each table. Instead of: A target has the following attributes: I would say: A <target> element has the following attributes: -- Configure bugmail: http://issues.apache.org/bugzilla/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the assignee for the bug, or are watching the assignee. --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
