[Webkit-unassigned] [Bug 34822] New: webkit-build-directory misuses terms

[bugzilla-daemon at webkit.org]

https://bugs.webkit.org/show_bug.cgi?id=34822

           Summary: webkit-build-directory misuses terms
           Product: WebKit
           Version: 528+ (Nightly build)
          Platform: PC
        OS/Version: Mac OS X 10.5
            Status: NEW
          Severity: Normal
          Priority: P2
         Component: Tools / Tests
        AssignedTo: webkit-unassigned at lists.webkit.org
        ReportedBy: eric at webkit.org
                CC: mrowe at apple.com


>From an email from Mark Rowe:


Added: trunk/WebKitTools/Scripts/webkit-build-directory (0 => 54634)

--- trunk/WebKitTools/Scripts/webkit-build-directory                           
(rev 0)
+++ trunk/WebKitTools/Scripts/webkit-build-directory    2010-02-11 01:24:04 UTC
(rev 54634)
@@ -0,0 +1,65 @@

+my $programName = basename($0);
+my $usage = <<EOF;
+Usage: $programName [options]
+  --base      Show the root build directory instead of one corresponding to
the current target (e.g. Debug, Release)
+  --debug     Show build directory for the Debug target
+  -h|--help   Show this help message
+  --release   Show build directory for the Release target
+EOF

The terminology used here is wrong.  Debug and Release are configurations, not
targets.  A target is a result of a build (such as derived source file
generation, or the WebKit framework).

The documentation for --base is also confusing.  It talks about a "root build
directory" while the option name implies it is the "base build directory". 
Presumably they're the same thing so we should pick a single name for them.
+
+setConfiguration(); # Figure out from the command line if we're --debug or
--release or the default.
… this is why the method to process these flags uses the term configuration ;-)

It would probably be clearer to explain the behavior in terms of two modes: one
that shows the base build directory, and a second that shows the
per-configuration build directory.  I would suggest using explicit flags to
select the mode of operation, since as it stands the default behavior is
somewhat confusing (it will show the per-configuration build directory for the
active configuration).

== end email ==

I'm about to prepare a patch to fix the Configuration/Target confusion.  I'm
not sure I understand the suggestion with regards to the flags.  The current
behavior is designed to be "correct" for any shell script/Makefile which wants
to know where to put output.  But you're right, that may be confusing to users
just running the script without args.

Could you give an example of another interface you'd prefer?

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