Skip to content
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

Document update process #46

Open
juliangruber opened this issue Mar 15, 2023 · 5 comments
Open

Document update process #46

juliangruber opened this issue Mar 15, 2023 · 5 comments

Comments

@juliangruber
Copy link
Member

@MoLow I would like to update this repo from node core. What's your process for applying the patches, as in #45?

@MoLow
Copy link
Member

MoLow commented Mar 15, 2023

@juliangruber
Copy link
Member Author

Awesome, thank you! I'll update today then

@juliangruber
Copy link
Member Author

How do you deal with conflicts on the the docs, which live in different files?

$ git cherry-pick -x be4921474671fb15f0e62adfe2f37253d07eca02
CONFLICT (modify/delete): doc/api/test.md deleted in HEAD and modified in be49214746 (doc: fix test runner examples).  Version be49214746 (doc: fix test runner examples) of doc/api/test.md left in tree.
error: could not apply be49214746... doc: fix test runner examples
hint: After resolving the conflicts, mark them with
hint: "git add/rm <pathspec>", then run
hint: "git cherry-pick --continue".
hint: You can instead skip this commit with "git cherry-pick --skip".
hint: To abort and get back to the state before "git cherry-pick",
hint: run "git cherry-pick --abort".
$ gs
On branch update-2023-03-15
You are currently cherry-picking commit be49214746.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	deleted by us:   doc/api/test.md

@juliangruber juliangruber reopened this Mar 15, 2023
@MoLow
Copy link
Member

MoLow commented Mar 15, 2023

Sadly there is no easy way. I used manual comparison

@juliangruber
Copy link
Member Author

What about we move the docs to doc/api/test.md for real, just include basic docs in the README (like install and a tiny example), and link to there? The ease of updating would be worth it to me

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants