docs: add gf180mcu process and per-origin credentials behaviour#3
Merged
Conversation
Catches the training docs up with two recent chipflow-lib changes: - #169 adds Process.GF180MCU = "gf180mcu", and the matching backend techno plugin plus SRAM IP make it end-to-end usable, including automatic memory inference. Listed alongside ihp_sg13g2 in both the Supported Processes table and the chipflow.toml reference. - The credentials file is now keyed by origin instead of holding a single api_key, and 'chipflow auth login' always re-mints rather than reusing a cached key. Documents the new file shape, the automatic migration of legacy single-key files, and the per-origin scope of logout.
34d1046 to
cde003c
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Catches the training docs up with two recent chipflow-lib changes.
chipflow-lib #169 —
gf180mcuprocess variant. Added alongsideihp_sg13g2in both the Supported Processes table and thechipflow.tomlreference, with a one-line note that both processes support automatic SRAM inference.chipflow-lib auth fix (
cd821647) — credentials file is now keyed by origin ({origins: {<url>: {api_key: ...}}}) instead of holding a singleapi_key, andchipflow auth loginalways re-mints rather than reusing a cached key. The "Check saved credentials" section gains an example of the new file shape, mentions automatic migration of legacy single-key files, and explains the always-re-mint behaviour. "Logout" gets a one-liner noting its per-origin scope.Test plan
chipflow-toml-reference.mdandtraining-commands.mdand confirm thegf180mcurow and the Supported Processes table look correct.cat ~/.config/chipflow/credentialson a freshly authenticated machine shows the documented{"origins": {…}}shape.chipflow auth loginagainst an alternate origin doesn't clobber the existing entry.