Restructure YAML package suitable for pub lish

Restructure YAML package suitable for pub lish
After this I can use tools/publish_pkg.py upload script to fix dartbug.com/4126

Committed: https://code.google.com/p/dart/source/detail?r=17685

[Jennifer Messerly, 2012-12-17 23:22:04]

Does the description/documentation look okay?

Seeing "lib" in an import is a bit strange, but I didn't want this upload to be
blocked by all of the various blocking bugs about using package: inside Pub
itself. Of course "pkg/yaml/lib" will be the right place for this code
eventually, and Pub using package:yaml imports.

[nweiz, 2012-12-18 18:45:17]

While you're doing this, you might as well move this into pkg.

https://codereview.chromium.org/11622011/diff/1/utils/pub/yaml/lib/yaml.dart
File utils/pub/yaml/lib/yaml.dart (right):

https://codereview.chromium.org/11622011/diff/1/utils/pub/yaml/lib/yaml.dart#...
utils/pub/yaml/lib/yaml.dart:16: */
It would be good to mention that this library currently doesn't support dumping
to YAML, and that JSON.stringify should be used instead.

Also, please use "///"-style comments.

[Jennifer Messerly, 2012-12-18 18:59:31]

AFAIK, it's not possible to move to pkg yet, until "package:" imports are
supported. The relative path would not work (SDK has "lib" and "pkg" as
siblings, repo has "sdk/lib" and "pkg" as siblings.)

https://codereview.chromium.org/11622011/diff/1/utils/pub/yaml/lib/yaml.dart
File utils/pub/yaml/lib/yaml.dart (right):

https://codereview.chromium.org/11622011/diff/1/utils/pub/yaml/lib/yaml.dart#...
utils/pub/yaml/lib/yaml.dart:16: */
On 2012/12/18 18:45:17, nweiz wrote:
> It would be good to mention that this library currently doesn't support
dumping
> to YAML, and that JSON.stringify should be used instead.

Sure.
 
> Also, please use "///"-style comments.

Confused. The rest of the file does not follow that style. "///" would violate
the number one style rule -- be consistent.

[nweiz, 2012-12-18 19:02:53]

https://codereview.chromium.org/11622011/diff/1/utils/pub/yaml/lib/yaml.dart
File utils/pub/yaml/lib/yaml.dart (right):

https://codereview.chromium.org/11622011/diff/1/utils/pub/yaml/lib/yaml.dart#...
utils/pub/yaml/lib/yaml.dart:16: */
On 2012/12/18 18:59:31, John Messerly wrote:
> Confused. The rest of the file does not follow that style. "///" would violate
> the number one style rule -- be consistent.

Our policy in pub, which I think makes sense for this library, is to gradually
move comments over to "///" style when we touch them or write new ones.

[Jennifer Messerly, 2013-01-26 01:25:32]

PTAL! Comment now uses "///" and moved it under to pkg

[Jennifer Messerly, 2013-01-26 01:28:55]

On 2013/01/26 01:25:32, John Messerly wrote:
> PTAL! Comment now uses "///" and moved it under to pkg

BTW, I tried these test configurations:

$ ./tools/test.py -m release pub
$ ./tools/test.py -m release pkg
$ ./tools/test.py -m release -c dart2js -r drt pkg

Anything else worth trying?

I dug around in the status file, but it's hard to tell if Pub has the same set
of exclusions as pkg.

I do know that it ran the tests after I moved them, because some were failing
due to my editor stripping whitespace in the yaml_test file.

[Bob Nystrom, 2013-01-26 01:39:33]

LGTM!

One other thing that's good to test: Build the SDK and then invoke pub from
<build>/<config>dart-sdk/bin/pub and make sure it can still find YAML.

Since create_sdk.py munges some paths, sometimes things work in the repo and not
the SDK. Any pub command (like pub help) should work here, I think.

https://codereview.chromium.org/11622011/diff/9001/pkg/yaml/lib/yaml.dart
File pkg/yaml/lib/yaml.dart (right):

https://codereview.chromium.org/11622011/diff/9001/pkg/yaml/lib/yaml.dart#new...
pkg/yaml/lib/yaml.dart:5: /// A parser for [YAML](http://www.yaml.org/).
Maybe a quick README.md file with this too?

[Jennifer Messerly, 2013-01-26 01:42:38]

yeah I will try running Pub from SDK layout. That was kind of what made me
nervous about moving yaml ... I guess we'll see :)

https://codereview.chromium.org/11622011/diff/9001/pkg/yaml/lib/yaml.dart
File pkg/yaml/lib/yaml.dart (right):

https://codereview.chromium.org/11622011/diff/9001/pkg/yaml/lib/yaml.dart#new...
pkg/yaml/lib/yaml.dart:5: /// A parser for [YAML](http://www.yaml.org/).
On 2013/01/26 01:39:33, Bob Nystrom wrote:
> Maybe a quick README.md file with this too?

Sure. Anything else I should say besides this content here?
Maybe a link to code.google.com/p/dart and issue tracker?

Also it looks like we need readmes in all of the PKG things :)

[Jennifer Messerly, 2013-01-26 01:46:38]

On 2013/01/26 01:42:38, John Messerly wrote:
> yeah I will try running Pub from SDK layout. That was kind of what made me
> nervous about moving yaml ... I guess we'll see :)
> 
> https://codereview.chromium.org/11622011/diff/9001/pkg/yaml/lib/yaml.dart
> File pkg/yaml/lib/yaml.dart (right):
> 
>
https://codereview.chromium.org/11622011/diff/9001/pkg/yaml/lib/yaml.dart#new...
> pkg/yaml/lib/yaml.dart:5: /// A parser for [YAML](http://www.yaml.org/).
> On 2013/01/26 01:39:33, Bob Nystrom wrote:
> > Maybe a quick README.md file with this too?
> 
> Sure. Anything else I should say besides this content here?
> Maybe a link to code.google.com/p/dart and issue tracker?
> 
> Also it looks like we need readmes in all of the PKG things :)

Update: it does not work. I'll have to revert to the file system layout in my
patchset #1. Unless we can use "package:", which I think you said doesn't work
in Pub itself?

[Jennifer Messerly, 2013-01-26 01:51:27]

PTAL. I needed some create_sdk magic:

https://codereview.chromium.org/11622011/diff2/9001:10024/tools/create_sdk.py

[Jennifer Messerly, 2013-01-26 01:55:48]

also took a shot at the readme

[Bob Nystrom, 2013-01-26 02:01:31]

LGTM again!

One more thing: you'll want to add it to the exclude list in
utils/apidoc/apidoc.gyp. That will make sure the YAML docs don't show up on
api.dartlang.org.

[Jennifer Messerly, 2013-01-26 02:23:40]

On 2013/01/26 02:01:31, Bob Nystrom wrote:
> LGTM again!
> 
> One more thing: you'll want to add it to the exclude list in
> utils/apidoc/apidoc.gyp. That will make sure the YAML docs don't show up on
> http://api.dartlang.org.

done