SCons renaming updates for base, net and googleurl:

* Rename SConscript files to {module}.scons or {moduel}_lib.scons,
  depending on the primary target involved.
* Separate targets into individual *.scons files, with one
  construction environment (named "env") per *.scons file.
* Add using_{module}.scons files (like .vsprops) that will be used
  by other modules to add CPPDEFINES, CPPPATH, LIBS and LIBPATH values.
* Update other modules' *.scons files to use the new using_{module}.scons
  files (using a temporary one-liner idiom until we have the
  ApplySConscript() method from the Hammer modules).
* Use the idiom of removing to-be-ported files from the master list,
  so they can be simply deleted from the to-be-ported list as they
  get ported in the future, instead of having to shuffle entries
  between lists.
* Use $OBJ_ROOT instead of hard-coded '#/$BUILD_TYPE/' for the $*_DIR
  variables.
* Add a addRepository() call mapping build/ to $TARGET_ROOT/googleurl,
  so its $OBJ_ROOT value can look like the others'.
* Formatting changes, primarily modifying indentation to conform to
  style guidelines.
* Fix copyright headers in some third_party/* modules
  previously overlooked.
* Add rudimentary __doc__ strings, setting up for a future
  ability to generate meaningful documentation.


Review URL: http://codereview.chromium.org/7807

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@3675 0039d316-1c4b-4281-b951-d872f2087c98

14 files changed, 250 insertions, 244 deletions

diff --git a/third_party/bzip2/SConscript b/third_party/bzip2/SConscript
deleted file mode 100644
index 6eedeaf..0000000
--- a/third_party/bzip2/SConscript
+++ /dev/null
@@ -1,60 +0,0 @@
-# Copyright 2008, Google Inc.
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are
-# met:
-#
-#    * Redistributions of source code must retain the above copyright
-# notice, this list of conditions and the following disclaimer.
-#    * Redistributions in binary form must reproduce the above
-# copyright notice, this list of conditions and the following disclaimer
-# in the documentation and/or other materials provided with the
-# distribution.
-#    * Neither the name of Google Inc. nor the names of its
-# contributors may be used to endorse or promote products derived from
-# this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-# TODO(keunwoo): Use better cross-platform abstraction; see chrome/SConstruct
-Import('env')
-
-env = env.Clone()
-
-if env['PLATFORM'] == 'win32':
-  env.Append(
-      CCFLAGS = [
-          '/TC',
-          '/wd4996',
-          '/wd4800',
-      ],
-  )
-
-env.Append(
-    CPPDEFINES = [
-        'BZ_NO_STDIO',
-    ],
-)
-
-input_files = [
-    'blocksort.c',
-    'bzlib.c',
-    'compress.c',
-    'crctable.c',
-    'decompress.c',
-    'huffman.c',
-    'randtable.c',
-]
-
-env.ChromeStaticLibrary('bzip2', input_files)
diff --git a/third_party/bzip2/bzip2.scons b/third_party/bzip2/bzip2.scons
new file mode 100644
index 0000000..f1ad082
--- /dev/null
+++ b/third_party/bzip2/bzip2.scons
@@ -0,0 +1,38 @@
+# Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+__doc__ = """
+Configuration for building bzip2.lib / libbzip2.a.
+"""
+
+Import('env')
+
+env = env.Clone()
+
+if env['PLATFORM'] == 'win32':
+  env.Append(
+      CCFLAGS = [
+          '/TC',
+          '/wd4996',
+          '/wd4800',
+      ],
+  )
+
+env.Append(
+    CPPDEFINES = [
+        'BZ_NO_STDIO',
+    ],
+)
+
+input_files = [
+    'blocksort.c',
+    'bzlib.c',
+    'compress.c',
+    'crctable.c',
+    'decompress.c',
+    'huffman.c',
+    'randtable.c',
+]
+
+env.ChromeStaticLibrary('bzip2', input_files)
diff --git a/third_party/bzip2/using_bzip2.scons b/third_party/bzip2/using_bzip2.scons
new file mode 100644
index 0000000..a7706f5
--- /dev/null
+++ b/third_party/bzip2/using_bzip2.scons
@@ -0,0 +1,15 @@
+# Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+__doc__ = """
+Settings for other components using the bzip2 library.
+"""
+
+Import("env")
+
+env.Append(
+    LIBS = [
+        'bzip2',
+    ],
+)
diff --git a/third_party/libevent/SConscript b/third_party/libevent/libevent.scons
index 3d1eb9b..82e54ce 100644
--- a/third_party/libevent/SConscript
+++ b/third_party/libevent/libevent.scons
@@ -2,12 +2,16 @@
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
-# This SConscript is currently only suitable for Linux.
+
+__doc__ = """
+Configuration for building event.lib / libevent.a.
+
+This is currently only suitable for Linux and Mac.
+"""
 
 Import('env')
 
-env = env.Clone(
-)
+env = env.Clone()
 
 env.Append(
     CPPDEFINES = [
diff --git a/third_party/libevent/using_libevent.scons b/third_party/libevent/using_libevent.scons
new file mode 100644
index 0000000..958c653
--- /dev/null
+++ b/third_party/libevent/using_libevent.scons
@@ -0,0 +1,15 @@
+# Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+__doc__ = """
+Settings for other components using the event library.
+"""
+
+Import("env")
+
+env.Append(
+    LIBS = [
+        'event',
+    ],
+)
diff --git a/third_party/libpng/SConscript b/third_party/libpng/SConscript
deleted file mode 100644
index 5beb689..0000000
--- a/third_party/libpng/SConscript
+++ /dev/null
@@ -1,77 +0,0 @@
-# Copyright 2008, Google Inc.
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are
-# met:
-#
-#    * Redistributions of source code must retain the above copyright
-# notice, this list of conditions and the following disclaimer.
-#    * Redistributions in binary form must reproduce the above
-# copyright notice, this list of conditions and the following disclaimer
-# in the documentation and/or other materials provided with the
-# distribution.
-#    * Neither the name of Google Inc. nor the names of its
-# contributors may be used to endorse or promote products derived from
-# this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-# TODO(keunwoo): Use better cross-platform abstraction; see chrome/SConstruct
-Import('env')
-
-env = env.Clone()
-
-env.Prepend(
-    CPPPATH = [
-        '#../third_party/zlib',
-        '#../',
-    ],
-)
-
-if env['PLATFORM'] == 'win32':
-  env.Append(
-      CCFLAGS = [
-          '/TP',
-          '/wd4800',
-      ],
-  )
-
-env.Append(
-    CPPDEFINES = [
-        'PNG_USER_CONFIG',
-        'CHROME_PNG_WRITE_SUPPORT',
-    ],
-)
-
-input_files = [
-    'png.c',
-    'pngwutil.c',
-    'pngwtran.c',
-    'pngwrite.c',
-    'pngwio.c',
-    'pngvcrd.c',
-    'pngtrans.c',
-    'pngset.c',
-    'pngrutil.c',
-    'pngrtran.c',
-    'pngrio.c',
-    'pngread.c',
-    'pngpread.c',
-    'pngmem.c',
-    'pngget.c',
-    'pnggccrd.c',
-    'pngerror.c',
-]
-
-env.ChromeStaticLibrary('libpng', input_files)
diff --git a/third_party/libpng/libpng.scons b/third_party/libpng/libpng.scons
new file mode 100644
index 0000000..7acba1c
--- /dev/null
+++ b/third_party/libpng/libpng.scons
@@ -0,0 +1,59 @@
+# Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+
+__doc__ = """
+Configuration for building libpng.lib / libpng.a.
+"""
+
+Import('env')
+
+env = env.Clone()
+
+env.SConscript([
+    '$ZLIB_DIR/using_zlib.scons',
+], {'env':env})
+
+env.Prepend(
+    CPPPATH = [
+        '$ROOT_DIR',
+    ],
+)
+
+if env['PLATFORM'] == 'win32':
+  env.Append(
+      CCFLAGS = [
+          '/TP',
+          '/wd4800',
+      ],
+  )
+
+env.Append(
+    CPPDEFINES = [
+        'PNG_USER_CONFIG',
+        'CHROME_PNG_WRITE_SUPPORT',
+    ],
+)
+
+input_files = [
+    'png.c',
+    'pngwutil.c',
+    'pngwtran.c',
+    'pngwrite.c',
+    'pngwio.c',
+    'pngvcrd.c',
+    'pngtrans.c',
+    'pngset.c',
+    'pngrutil.c',
+    'pngrtran.c',
+    'pngrio.c',
+    'pngread.c',
+    'pngpread.c',
+    'pngmem.c',
+    'pngget.c',
+    'pnggccrd.c',
+    'pngerror.c',
+]
+
+env.ChromeStaticLibrary('libpng', input_files)
diff --git a/third_party/libpng/using_libpng.scons b/third_party/libpng/using_libpng.scons
new file mode 100644
index 0000000..68b9c3f
--- /dev/null
+++ b/third_party/libpng/using_libpng.scons
@@ -0,0 +1,22 @@
+# Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+__doc__ = """
+Settings for other components using the libpng library.
+"""
+
+Import("env")
+
+env.Append(
+    CPPPATH = [
+        '$LIBPNG_DIR',
+    ],
+    CPPDEFINES = [
+        'PNG_USER_CONFIG',
+        'CHROME_PNG_WRITE_SUPPORT',
+    ],
+    LIBS = [
+        'libpng',
+    ],
+)
diff --git a/third_party/modp_b64/SConscript b/third_party/modp_b64/SConscript
deleted file mode 100644
index 37f9ca5..0000000
--- a/third_party/modp_b64/SConscript
+++ /dev/null
@@ -1,46 +0,0 @@
-# Copyright 2008, Google Inc.
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are
-# met:
-#
-#    * Redistributions of source code must retain the above copyright
-# notice, this list of conditions and the following disclaimer.
-#    * Redistributions in binary form must reproduce the above
-# copyright notice, this list of conditions and the following disclaimer
-# in the documentation and/or other materials provided with the
-# distribution.
-#    * Neither the name of Google Inc. nor the names of its
-# contributors may be used to endorse or promote products derived from
-# this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-Import('env')
-
-env = env.Clone(
-    PDB = 'vc80.pdb',
-)
-
-env.Prepend(
-    CPPPATH = [
-        '#/..',
-    ],
-)
-
-input_files = [
-    'modp_b64.cc',
-]
-
-env.ChromeStaticLibrary('modp_b64', input_files)
diff --git a/third_party/modp_b64/modp_b64.scons b/third_party/modp_b64/modp_b64.scons
new file mode 100644
index 0000000..02cefb4
--- /dev/null
+++ b/third_party/modp_b64/modp_b64.scons
@@ -0,0 +1,25 @@
+# Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+__doc__ = """
+Configuration for building modp_b64.lib / libmodp_b64.a.
+"""
+
+Import('env')
+
+env = env.Clone(
+    PDB = 'vc80.pdb',
+)
+
+env.Prepend(
+    CPPPATH = [
+        '$ROOT_DIR',
+    ],
+)
+
+input_files = [
+    'modp_b64.cc',
+]
+
+env.ChromeStaticLibrary('modp_b64', input_files)
diff --git a/third_party/modp_b64/using_modp_b64.scons b/third_party/modp_b64/using_modp_b64.scons
new file mode 100644
index 0000000..f4637db
--- /dev/null
+++ b/third_party/modp_b64/using_modp_b64.scons
@@ -0,0 +1,15 @@
+# Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+__doc__ = """
+Settings for other components using the modp_b64 library.
+"""
+
+Import("env")
+
+env.Append(
+    LIBS = [
+        'modp_b64',
+    ],
+)
diff --git a/third_party/zlib/SConscript b/third_party/zlib/SConscript
deleted file mode 100644
index 490ce01..0000000
--- a/third_party/zlib/SConscript
+++ /dev/null
@@ -1,58 +0,0 @@
-# Copyright 2008, Google Inc.
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are
-# met:
-#
-#    * Redistributions of source code must retain the above copyright
-# notice, this list of conditions and the following disclaimer.
-#    * Redistributions in binary form must reproduce the above
-# copyright notice, this list of conditions and the following disclaimer
-# in the documentation and/or other materials provided with the
-# distribution.
-#    * Neither the name of Google Inc. nor the names of its
-# contributors may be used to endorse or promote products derived from
-# this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-# TODO(keunwoo): Use better cross-platform abstraction; see chrome/SConstruct
-Import('env')
-
-env = env.Clone()
-
-if env['PLATFORM'] == 'win32':
-  env.Append(
-      CCFLAGS = [
-          '/TC',
-          '/wd4800',
-      ],
-  )
-
-input_files = [
-    'adler32.c',
-    'compress.c',
-    'crc32.c',
-    'deflate.c',
-    'gzio.c',
-    'infback.c',
-    'inffast.c',
-    'inflate.c',
-    'inftrees.c',
-    'trees.c',
-    'uncompr.c',
-    'zutil.c',
-]
-
-env.ChromeStaticLibrary('zlib', input_files)
diff --git a/third_party/zlib/using_zlib.scons b/third_party/zlib/using_zlib.scons
new file mode 100644
index 0000000..60bceb7
--- /dev/null
+++ b/third_party/zlib/using_zlib.scons
@@ -0,0 +1,18 @@
+# Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+__doc__ = """
+Settings for other components using the zlib library.
+"""
+
+Import("env")
+
+env.Append(
+    CPPPATH = [
+        '$ZLIB_DIR',
+    ],
+    LIBS = [
+        'zlib',
+    ],
+)
diff --git a/third_party/zlib/zlib.scons b/third_party/zlib/zlib.scons
new file mode 100644
index 0000000..a7dcb89
--- /dev/null
+++ b/third_party/zlib/zlib.scons
@@ -0,0 +1,36 @@
+# Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+__doc__ = """
+Configuration for building zlib.lib / libzlib.a.
+"""
+
+Import('env')
+
+env = env.Clone()
+
+if env['PLATFORM'] == 'win32':
+  env.Append(
+      CCFLAGS = [
+          '/TC',
+          '/wd4800',
+      ],
+  )
+
+input_files = [
+    'adler32.c',
+    'compress.c',
+    'crc32.c',
+    'deflate.c',
+    'gzio.c',
+    'infback.c',
+    'inffast.c',
+    'inflate.c',
+    'inftrees.c',
+    'trees.c',
+    'uncompr.c',
+    'zutil.c',
+]
+
+env.ChromeStaticLibrary('zlib', input_files)