Skip to content

Copy doc files from new to old location.#109316

Merged
auto-submit[bot] merged 2 commits intoflutter:masterfrom
godofredoc:fix_docs
Aug 10, 2022
Merged

Copy doc files from new to old location.#109316
auto-submit[bot] merged 2 commits intoflutter:masterfrom
godofredoc:fix_docs

Conversation

@godofredoc
Copy link
Contributor

Changes to the objectc docs to make destination paths consistent cause
failures in the documentation scripts becase some of the files could not
be found anymore. This change copies files to the old location if it
identifies the new location exist.

Bug: #109229

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
  • I signed the CLA.
  • I listed at least one issue that this PR fixes in the description above.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or this PR is test-exempt.
  • All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Changes to the objectc docs to make destination paths consistent cause
failures in the documentation scripts becase some of the files could not
be found anymore. This change copies files to the old location if it
identifies the new location exist.

Bug: #109229
@flutter-dashboard flutter-dashboard bot added the c: contributor-productivity Team-specific productivity, code health, technical debt. label Aug 10, 2022
@flutter-dashboard
Copy link

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie on the #hackers channel in Chat (don't just cc him here, he won't see it! He's on Discord!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

@godofredoc
Copy link
Contributor Author

This is needed to reland flutter/engine#35265

}
}

/// If object then copy files to old location if the archive is using the new location.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you give me some context on why we have a new and old location? are the contents different?

Copy link
Contributor Author

@godofredoc godofredoc Aug 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The contents are the same but the folder structure added an objectc_docs folder and puts all the contents there.

The context of that change is that with recipes v2 migration we are moving the generation of the zip files from the recipes to the engine and having the additional folder helps us prevent adding additional files to the zip if for some reason a nonempty directory is passed to the tools/gen_objcdoc.sh script.

After the migration to engine v2 is complete we can get rid of this additional complexity.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SGTM

Copy link
Contributor

@christopherfujino christopherfujino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autosubmit Merge PR when tree becomes green via auto submit App c: contributor-productivity Team-specific productivity, code health, technical debt.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants