Skip to content

Document update process #46

Description

@juliangruber

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

Activity

  1. MoLow commented on Mar 15, 2023

    @MoLow
    Member
  2. juliangruber commented on Mar 15, 2023

    @juliangruber
    MemberAuthor

    Awesome, thank you! I'll update today then

  3. juliangruber commented on Mar 15, 2023

    @juliangruber
    MemberAuthor

    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
    
    
  4. MoLow commented on Mar 15, 2023

    @MoLow
    Member

    Sadly there is no easy way. I used manual comparison

  5. juliangruber commented on Mar 15, 2023

    @juliangruber
    MemberAuthor

    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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions