docs: correct spec docs of fswap module #1419

170210 · 2024-06-12T09:40:25Z

Description

closes: #XXXX

Motivation and context

How has this been tested?

Screenshots (if appropriate):

Checklist:

I followed the contributing guidelines and code of conduct.
I have added a relevant changelog to CHANGELOG.md
I have added tests to cover my changes.
I have updated the documentation accordingly.
I have updated API documentation client/docs/swagger-ui/swagger.yaml

Signed-off-by: 170210 <j170210@icloud.com>

codecov · 2024-06-12T09:47:06Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.62%. Comparing base (d60e44a) to head (56c86c4).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1419      +/-   ##
==========================================
- Coverage   69.63%   69.62%   -0.01%     
==========================================
  Files         751      751              
  Lines       62055    61854     -201     
==========================================
- Hits        43210    43068     -142     
+ Misses      16214    16155      -59     
  Partials     2631     2631

Files	Coverage Δ
x/fswap/keeper/keys.go	`86.66% <ø> (ø)`

... and 2 files with indirect coverage changes

Signed-off-by: 170210 <j170210@icloud.com>

x/fswap/spec/01_concepts.md

Signed-off-by: 170210 <j170210@icloud.com>

x/fswap/spec/01_concepts.md

Signed-off-by: 170210 <j170210@icloud.com>

x/fswap/spec/01_concepts.md

Signed-off-by: 170210 <j170210@icloud.com>

0Tech

LGTM

x/fswap/spec/01_concepts.md

Signed-off-by: 170210 <j170210@icloud.com>

* docs: correct spec docs of fswap module Signed-off-by: 170210 <j170210@icloud.com> * chore: correct comment of storeKey Signed-off-by: 170210 <j170210@icloud.com> * chore: update CHANGLOG.md Signed-off-by: 170210 <j170210@icloud.com> * fix: fix for comment Signed-off-by: 170210 <j170210@icloud.com> * chore: fix format Signed-off-by: 170210 <j170210@icloud.com> * fix: fix for comment Signed-off-by: 170210 <j170210@icloud.com> * fixup: fix for comment Signed-off-by: 170210 <j170210@icloud.com> * fixup: fix for comment Signed-off-by: 170210 <j170210@icloud.com> * fixup: fix for comment Signed-off-by: 170210 <j170210@icloud.com> * fixup: fix for comment Signed-off-by: 170210 <j170210@icloud.com> --------- Signed-off-by: 170210 <j170210@icloud.com> (cherry picked from commit 7bd6c82) # Conflicts: # CHANGELOG.md

* docs: correct spec docs of fswap module (#1419) * docs: correct spec docs of fswap module Signed-off-by: 170210 <j170210@icloud.com> * chore: correct comment of storeKey Signed-off-by: 170210 <j170210@icloud.com> * chore: update CHANGLOG.md Signed-off-by: 170210 <j170210@icloud.com> * fix: fix for comment Signed-off-by: 170210 <j170210@icloud.com> * chore: fix format Signed-off-by: 170210 <j170210@icloud.com> * fix: fix for comment Signed-off-by: 170210 <j170210@icloud.com> * fixup: fix for comment Signed-off-by: 170210 <j170210@icloud.com> * fixup: fix for comment Signed-off-by: 170210 <j170210@icloud.com> * fixup: fix for comment Signed-off-by: 170210 <j170210@icloud.com> * fixup: fix for comment Signed-off-by: 170210 <j170210@icloud.com> --------- Signed-off-by: 170210 <j170210@icloud.com> (cherry picked from commit 7bd6c82) # Conflicts: # CHANGELOG.md * fix: fix conflict Signed-off-by: 170210 <j170210@icloud.com> --------- Signed-off-by: 170210 <j170210@icloud.com> Co-authored-by: Ki <85928898+170210@users.noreply.github.com> Co-authored-by: 170210 <j170210@icloud.com>

…schia#1429) * docs: correct spec docs of fswap module (Finschia#1419) * docs: correct spec docs of fswap module Signed-off-by: 170210 <j170210@icloud.com> * chore: correct comment of storeKey Signed-off-by: 170210 <j170210@icloud.com> * chore: update CHANGLOG.md Signed-off-by: 170210 <j170210@icloud.com> * fix: fix for comment Signed-off-by: 170210 <j170210@icloud.com> * chore: fix format Signed-off-by: 170210 <j170210@icloud.com> * fix: fix for comment Signed-off-by: 170210 <j170210@icloud.com> * fixup: fix for comment Signed-off-by: 170210 <j170210@icloud.com> * fixup: fix for comment Signed-off-by: 170210 <j170210@icloud.com> * fixup: fix for comment Signed-off-by: 170210 <j170210@icloud.com> * fixup: fix for comment Signed-off-by: 170210 <j170210@icloud.com> --------- Signed-off-by: 170210 <j170210@icloud.com> (cherry picked from commit 7bd6c82) # Conflicts: # CHANGELOG.md * fix: fix conflict Signed-off-by: 170210 <j170210@icloud.com> --------- Signed-off-by: 170210 <j170210@icloud.com> Co-authored-by: Ki <85928898+170210@users.noreply.github.com> Co-authored-by: 170210 <j170210@icloud.com> (cherry picked from commit 8c5ab7e)

* chore: update release changelog for v0.49.1 * docs: correct spec docs of fswap module (backport #1419) (#1429) * docs: correct spec docs of fswap module (#1419) * docs: correct spec docs of fswap module Signed-off-by: 170210 <j170210@icloud.com> * chore: correct comment of storeKey Signed-off-by: 170210 <j170210@icloud.com> * chore: update CHANGLOG.md Signed-off-by: 170210 <j170210@icloud.com> * fix: fix for comment Signed-off-by: 170210 <j170210@icloud.com> * chore: fix format Signed-off-by: 170210 <j170210@icloud.com> * fix: fix for comment Signed-off-by: 170210 <j170210@icloud.com> * fixup: fix for comment Signed-off-by: 170210 <j170210@icloud.com> * fixup: fix for comment Signed-off-by: 170210 <j170210@icloud.com> * fixup: fix for comment Signed-off-by: 170210 <j170210@icloud.com> * fixup: fix for comment Signed-off-by: 170210 <j170210@icloud.com> --------- Signed-off-by: 170210 <j170210@icloud.com> (cherry picked from commit 7bd6c82) # Conflicts: # CHANGELOG.md * fix: fix conflict Signed-off-by: 170210 <j170210@icloud.com> --------- Signed-off-by: 170210 <j170210@icloud.com> Co-authored-by: Ki <85928898+170210@users.noreply.github.com> Co-authored-by: 170210 <j170210@icloud.com> (cherry picked from commit 8c5ab7e) * chore: apply the changes of #1429 --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

170210 added 2 commits June 12, 2024 18:38

docs: correct spec docs of fswap module

07bd6cf

Signed-off-by: 170210 <j170210@icloud.com>

chore: correct comment of storeKey

cf5c7ae

Signed-off-by: 170210 <j170210@icloud.com>

chore: update CHANGLOG.md

9209c02

Signed-off-by: 170210 <j170210@icloud.com>

170210 self-assigned this Jun 12, 2024

170210 marked this pull request as ready for review June 12, 2024 09:47

170210 requested review from tkxkd0159, zemyblue, 0Tech and jaeseung-bae as code owners June 12, 2024 09:47

170210 added backport/v0.49.x documentation Improvements or additions to documentation C:x/fswap labels Jun 12, 2024

0Tech reviewed Jun 13, 2024

View reviewed changes

x/fswap/spec/01_concepts.md Outdated Show resolved Hide resolved

x/fswap/spec/01_concepts.md Show resolved Hide resolved

x/fswap/spec/01_concepts.md Show resolved Hide resolved

170210 added 2 commits June 14, 2024 16:42

fix: fix for comment

e5ca5c9

Signed-off-by: 170210 <j170210@icloud.com>

chore: fix format

541b7e7

Signed-off-by: 170210 <j170210@icloud.com>

0Tech reviewed Jun 16, 2024

View reviewed changes

x/fswap/spec/01_concepts.md Outdated Show resolved Hide resolved

x/fswap/spec/01_concepts.md Outdated Show resolved Hide resolved

fix: fix for comment

1344afc

Signed-off-by: 170210 <j170210@icloud.com>

170210 requested a review from 0Tech June 19, 2024 09:06

jaeseung-bae reviewed Jun 24, 2024

View reviewed changes

x/fswap/spec/01_concepts.md Outdated Show resolved Hide resolved

x/fswap/spec/01_concepts.md Outdated Show resolved Hide resolved

170210 added 3 commits June 24, 2024 10:44

Merge remote-tracking branch 'finschia/main' into correct_fswap_spec

a8941d6

fixup: fix for comment

03d01f1

Signed-off-by: 170210 <j170210@icloud.com>

fixup: fix for comment

21afae9

Signed-off-by: 170210 <j170210@icloud.com>

jaeseung-bae self-requested a review June 24, 2024 07:16

jaeseung-bae previously approved these changes Jun 24, 2024

View reviewed changes

0Tech previously approved these changes Jun 24, 2024

View reviewed changes

x/fswap/spec/01_concepts.md Outdated Show resolved Hide resolved

fixup: fix for comment

c106f0d

Signed-off-by: 170210 <j170210@icloud.com>

170210 dismissed stale reviews from 0Tech and jaeseung-bae via c106f0d June 24, 2024 07:31

170210 requested a review from 0Tech June 24, 2024 07:32

170210 requested a review from jaeseung-bae June 24, 2024 07:32

jaeseung-bae previously approved these changes Jun 24, 2024

View reviewed changes

fixup: fix for comment

56c86c4

Signed-off-by: 170210 <j170210@icloud.com>

170210 dismissed jaeseung-bae’s stale review via 56c86c4 June 24, 2024 07:33

170210 requested a review from jaeseung-bae June 24, 2024 07:34

jaeseung-bae approved these changes Jun 24, 2024

View reviewed changes

0Tech approved these changes Jun 24, 2024

View reviewed changes

170210 merged commit 7bd6c82 into Finschia:main Jun 24, 2024
38 checks passed

170210 deleted the correct_fswap_spec branch June 24, 2024 07:43

mergify bot mentioned this pull request Jun 24, 2024

docs: correct spec docs of fswap module (backport #1419) #1429

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: correct spec docs of fswap module #1419

docs: correct spec docs of fswap module #1419

170210 commented Jun 12, 2024 •

edited

Loading

codecov bot commented Jun 12, 2024 •

edited

Loading

0Tech left a comment

docs: correct spec docs of fswap module #1419

docs: correct spec docs of fswap module #1419

Conversation

170210 commented Jun 12, 2024 • edited Loading

Description

Motivation and context

How has this been tested?

Screenshots (if appropriate):

Checklist:

codecov bot commented Jun 12, 2024 • edited Loading

Codecov Report

0Tech left a comment

Choose a reason for hiding this comment

170210 commented Jun 12, 2024 •

edited

Loading

codecov bot commented Jun 12, 2024 •

edited

Loading