Skip to content

Generate docs fails for flutter packages when FLUTTER_ROOT is not set #1705

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
trevorwang opened this issue Jun 1, 2018 · 4 comments
Closed
Labels
P1 A high priority bug; for example, a single project is unusable or has many test failures

Comments

@trevorwang
Copy link

https://pub.dartlang.org/documentation/fzxing/0.1.0+2/log.txt

STDERR:

Generation failed: Invalid argument(s): join(null, "bin", "cache", "dart-sdk"): part 0 was null, but part 1 was not.
package:path/src/context.dart 1088                                           _validateArgList
package:path/src/context.dart 231                                            Context.join
package:path/path.dart 257                                                   join
package:dartdoc/src/dartdoc_options.dart 1114                                createDartdocOptions.<fn>
package:dartdoc/src/dartdoc_options.dart 421                                 DartdocOption&&DartdocSyntheticOption._valueAtFromSynthetic
package:dartdoc/src/dartdoc_options.dart 382                                 DartdocOptionArgSynth.valueAt
package:dartdoc/src/dartdoc_options.dart 948                                 DartdocOptionContext.sdkDir
package:dartdoc/src/package_meta.dart 90                                     new PackageMeta.fromElement
package:dartdoc/src/model.dart 5488                                          PackageBuilder.processLibrary
@jcollins-g jcollins-g added type-bug Incorrect behavior (everything from a crash to more subtle misbehavior) P2 A bug or feature request we're likely to work on and removed type-bug Incorrect behavior (everything from a crash to more subtle misbehavior) labels Jun 1, 2018
@jcollins-g jcollins-g changed the title Generate docs failed Generate docs fails for flutter packages when FLUTTER_ROOT is not set Jun 1, 2018
@jcollins-g jcollins-g added P1 A high priority bug; for example, a single project is unusable or has many test failures and removed P2 A bug or feature request we're likely to work on labels Jun 1, 2018
@jcollins-g
Copy link
Contributor

This exception should be improved -- the root cause is that FLUTTER_ROOT was not set in the environment.

@isoos , could this be a problem with how the pub site is running dartdoc? Without FLUTTER_ROOT dartdoc can't figure out how to link to flutter for packages using it.

@isoos
Copy link
Contributor

isoos commented Jun 2, 2018

We were always setting the FLUTTER_SDK variable.
Should we set FLUTTER_ROOT as well, or only the later?

@jcollins-g
Copy link
Contributor

For Dartdoc, the FLUTTER_ROOT environment variable must be set; we don't directly use FLUTTER_SDK.

@jcollins-g
Copy link
Contributor

@isoos I'm not sure FLUTTER_SDK is a thing; searches in the flutter repository for this string come up empty.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P1 A high priority bug; for example, a single project is unusable or has many test failures
Projects
None yet
Development

No branches or pull requests

3 participants