Skip to content
This repository has been archived by the owner on Aug 18, 2020. It is now read-only.

[CO-354] docs: add configuration info for "protocolMagic" #3583

Merged
merged 3 commits into from
Oct 1, 2018

Conversation

rvl
Copy link
Contributor

@rvl rvl commented Sep 13, 2018

Description

Update configuration docs for protocolMagic/requiresNetworkMagic.

Linked issue

https://iohk.myjetbrains.com/youtrack/issue/CO-354

@rvl rvl requested review from mhuesch, intricate and a team September 13, 2018 03:30
@rvl rvl requested a review from erikd as a code owner September 13, 2018 03:30
erikd
erikd previously approved these changes Sep 13, 2018
Copy link
Member

@erikd erikd left a comment

Choose a reason for hiding this comment

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

Seems legit but would be good to get confirmation from @mhuesch or @intricate as well.

disassembler
disassembler previously approved these changes Sep 13, 2018
mhuesch
mhuesch previously approved these changes Sep 13, 2018
Copy link
Contributor

@mhuesch mhuesch left a comment

Choose a reason for hiding this comment

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

Looks good - just a minor and optional addition.

docs/configuration.md Outdated Show resolved Hide resolved
@rvl rvl dismissed stale reviews from mhuesch, disassembler, and erikd via ac71936 September 13, 2018 23:01
@rvl rvl changed the title [CO-354] docs: add configuration info for "protocolMagic" [release/1.3.1] [CO-354] docs: add configuration info for "protocolMagic" Sep 26, 2018
@rvl rvl changed the title [release/1.3.1] [CO-354] docs: add configuration info for "protocolMagic" [WIP] [CO-354] docs: add configuration info for "protocolMagic" Sep 27, 2018
@rvl rvl changed the base branch from release/1.3.1 to develop September 27, 2018 05:55
@rvl rvl added wip and removed release-1.3.1 labels Sep 27, 2018
@rvl
Copy link
Contributor Author

rvl commented Sep 27, 2018

This doc update needs to be completely redone since the config layout for CO-354 changed.
Due to time constraints I'm moving its target from release/1.3.1 to develop and adding label "wip".
I will rebase onto develop later.

@rvl rvl changed the title [WIP] [CO-354] docs: add configuration info for "protocolMagic" [CO-354] docs: add configuration info for "protocolMagic" Oct 1, 2018
@rvl rvl changed the base branch from develop to release/1.3.1 October 1, 2018 04:16
@rvl rvl added release-1.3.1 and removed wip labels Oct 1, 2018
@rvl
Copy link
Contributor Author

rvl commented Oct 1, 2018

It's updated now, and can be merged into release/1.3.1.

Copy link
Contributor

@angerman angerman left a comment

Choose a reason for hiding this comment

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

As @erikd and @mhuesch have given their technical input already and this is only a documentation change, looks good to me.

that the protocol magic value will be included in the address
format and hence transactions.

* `dbSerializeVersion` — **TODO**
Copy link
Contributor

Choose a reason for hiding this comment

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

Assuming this is "ok" to be left here; as there was a TODO in there before as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep, that's the only other setting in the core section, and I'm not sure what it does.

rvl added a commit to input-output-hk/daedalus that referenced this pull request Oct 1, 2018
@rvl rvl merged commit 9b7ff97 into release/1.3.1 Oct 1, 2018
@rvl rvl deleted the co-354-network-magic-doc branch October 1, 2018 09:23
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants