User's Guide: document ParseDepends()

[bdbaddog]

This issue was originally created at: 2008-04-02 15:18:42.
This issue was reported by: stevenknight.
stevenknight said at 2008-04-02 15:18:42

Add User's Guide section(s) with suitable simple examples.
Text can be sent to SK if you don't want to mess with the DocBook input files.

stevenknight said at 2008-04-02 15:18:51

Milestone.

stevenknight said at 2008-04-04 07:26:25

Reassigning per Ludwig.

pankrat said at 2008-04-12 18:02:27

Created an attachment (id=368)
User Doc Draft for ParseDepends

pankrat said at 2008-04-12 18:10:29

Attached a documentation draft, documented ParseDepends "as-is".

Please see also:

http://scons.tigris.org/servlets/ReadMsg?listName=dev&msgNo=5359

One note:

The automatically generated documentation didn't produce the expected commands.
Maybe the .d file is not generated/found in the doc environment? When run from
the console it works.

pankrat said at 2008-08-13 11:32:33

Created an attachment (id=468)
Completed user documentation for ParseDepends

pankrat said at 2008-08-13 11:51:42

The latest patch (468) is my reviewed and completed documentation draft for
ParseDepends(). However, I was not sure where to put the section and included it
in the Dependencies chapter (might as well fit in the Scanner or Misc chapter).
That is why I reassigned the issue to Steven.

stevenknight said at 2008-08-14 12:52:16

Updating target milestone. SK to review and integrate. --SK

stevenknight said at 2008-08-21 21:56:49

Hi Ludwig--

Looks good to me, modulo one small change. Could you change the title of the
section to:

<title>Dependencies From External Files: the &ParseDepends; Function</title>

Although the intended use is for compiler-generated files, the function could
obviously be used to read dependencies from any file formatted like a .d file,
regardless of how it was generated.

Where you put it seems as logical as any other place to me. We can always move
it later if we something better suggests itself, or we get some tangible
feedback from users.

Please go ahead and check it in to trunk; I'm trying hard to not leap to
integrating everything myself, so as to avoid being the bottleneck I've
sometimes been in the past. If you don't have time or otherwise can't, let me know.

Thanks for the very nice work,

pankrat said at 2008-08-22 08:52:56

Patch committed. Fixed in revision 3296.

pankrat attached parsedepends.tar at 2008-04-12 18:02:26.

User Doc Draft for ParseDepends

pankrat attached parsedepends-user.patch at 2008-08-13 11:32:33.

Completed user documentation for ParseDepends