Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / system / libbase / baaebd5dbfab86850fa4894f76ccf34a08e699b6
commitbaaebd5dbfab86850fa4894f76ccf34a08e699b6[log] [tgz]
authorZhomart Mukhamejanov <zhomart@google.com>Tue Apr 13 02:21:32 2021 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Tue Apr 13 02:21:32 2021 +0000
tree29b348c25163f9cf2f8941f2351ac0e7e01b35a6
parentdb1ba88d8fa138293079bacf1631e5730dc2c500 [diff]
parent43a44a42e0df58b4d4bd9b98edd3ef78d2a548ca [diff]
Add notes on how to enable VERBOSE am: 087b6880b7 am: dba5ac905d am: 43a44a42e0

Original change: https://android-review.googlesource.com/c/platform/system/libbase/+/1673550

Change-Id: Ica37ceca30c4130897c950d13a92ad52c8a57b22
tree: 29b348c25163f9cf2f8941f2351ac0e7e01b35a6
  1. include/
  2. tidy/
  3. .clang-format ⇨ ../../build/soong/scripts/system-clang-format-2
  4. abi_compatibility.cpp
  5. Android.bp
  6. chrono_utils.cpp
  7. chrono_utils_test.cpp
  8. cmsg.cpp
  9. cmsg_test.cpp
  10. CPPLINT.cfg
  11. endian_test.cpp
  12. errors_test.cpp
  13. errors_unix.cpp
  14. errors_windows.cpp
  15. expected_test.cpp
  16. file.cpp
  17. file_test.cpp
  18. format_benchmark.cpp
  19. function_ref_test.cpp
  20. logging.cpp
  21. logging_splitters.h
  22. logging_splitters_test.cpp
  23. logging_test.cpp
  24. macros_test.cpp
  25. mapped_file.cpp
  26. mapped_file_test.cpp
  27. no_destructor_test.cpp
  28. NOTICE
  29. OWNERS
  30. parsebool.cpp
  31. parsebool_test.cpp
  32. parsedouble_test.cpp
  33. parseint_test.cpp
  34. parsenetaddress.cpp
  35. parsenetaddress_fuzzer.cpp
  36. parsenetaddress_fuzzer.dict
  37. parsenetaddress_test.cpp
  38. PREUPLOAD.cfg
  39. process.cpp
  40. process_test.cpp
  41. properties.cpp
  42. properties_test.cpp
  43. README.md
  44. result_test.cpp
  45. scopeguard_test.cpp
  46. stringprintf.cpp
  47. stringprintf_test.cpp
  48. strings.cpp
  49. strings_test.cpp
  50. test_main.cpp
  51. TEST_MAPPING
  52. test_utils.cpp
  53. test_utils_test.cpp
  54. threads.cpp
  55. utf8.cpp
  56. utf8_test.cpp
README.md

libbase

Who is this library for?

This library is a collection of convenience functions to make common tasks easier and less error-prone.

In this context, "error-prone" covers both "hard to do correctly" and "hard to do with good performance", but as a general purpose library, libbase's primary focus is on making it easier to do things easily and correctly when a compromise has to be made between "simplest API" on the one hand and "fastest implementation" on the other. Though obviously the ideal is to have both.

Should my routine be added?

The intention is to cover the 80% use cases, not be all things to all users.

If you have a routine that's really useful in your project, congratulations. But that doesn't mean it should be here rather than just in your project.

The question for libbase is "should everyone be doing this?"/"does this make everyone's code cleaner/safer?". Historically we've considered the bar for inclusion to be "are there at least three unrelated projects that would be cleaned up by doing so".

If your routine is actually something from a future C++ standard (that isn't yet in libc++), or it's widely used in another library, that helps show that there's precedent. Being able to say "so-and-so has used this API for n years" is a good way to reduce concerns about API choices.

Any other restrictions?

Unlike most Android code, code in libbase has to build for Mac and Windows too.

Code here is also expected to have good test coverage.

By its nature, it's difficult to change libbase API. It's often best to start using your routine just in your project, and let it "graduate" after you're certain that the API is solid.