README.md: Update merge instructions

The branch names have changed and we didn't have any instructions on how
to push a merge commit.

BUG=b:198296022
TEST=view in gitiles

Change-Id: I9a35e817677807c4a40d5c37ece2a364787b47a3
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/cbor/+/3315411
Reviewed-by: Anastasiia N <anastasiian@chromium.org>
Reviewed-by: Josie Nordrum <josienordrum@google.com>
Tested-by: Tom Hughes <tomhughes@chromium.org>
Commit-Queue: Anastasiia N <anastasiian@chromium.org>
1 file changed
tree: be0db62170e9578effaf0492f97a7568a50fe55e
  1. reader_fuzzer_corpus/
  2. BUILD.gn
  3. cbor_export.h
  4. constants.h
  5. diagnostic_writer.cc
  6. diagnostic_writer.h
  7. diagnostic_writer_unittest.cc
  8. DIR_METADATA
  9. OWNERS
  10. reader.cc
  11. reader.h
  12. reader_fuzzer.cc
  13. reader_unittest.cc
  14. README.md
  15. values.cc
  16. values.h
  17. values_unittest.cc
  18. writer.cc
  19. writer.h
  20. writer_unittest.cc
README.md

cbor: Concise Binary Object Representation

This library is a partial implementation of the RFC 7049 Concise Binary Object Representation standard.

The source code was fetched from chromium/src in order to avoid code duplication.

The cros/upstream/main branch is a mirror of the components/cbor directory from upstream. It is automatically updated to reflect the latest changes in upstream.

How to update the source

To pull in updates from chromium/src, do the following:

  • git remote update

  • git checkout -b main cros/main

  • git merge cros/upstream/main

    • Expect merge conflicts, because of the difference in header paths.
    • OWNERS should use the version from main.
    • BUILD.gn should mostly use the version from main, unless the upstream changes the files to be built.
    • The #include paths should use the version from main (without “components/”). This should be the majority of the merge conflicts.
    • In the commit message of the merge, list the commits from upstream that are merged.
    • If you need to do make changes to the merged commits (outside of conflicts), do that work in separate commits. For example, if you need to revert commits, use git revert after committing the merge commit. This preserves the history and makes it clear why a change is being reverted rather than quietly changing it in the merge commit.
    • Check the changes introduced by your merge by doing a diff against the commit before the merge. The difference should be the same as the changes in the upstream.
  • Push the resulting merge commit with:

    (chroot) $ git push HEAD:refs/for/main