Building Superior Embedded Systems
Continue reading "Dealing With Duplicated Files in a Monorepo"
19 May 2020 by Phillip Johnston • Last updated 14 December 2021 When maintaining an API, it is important to provide stability for your users. The prime directive of API maintenance is to never remove anything from or change anything about an interface. However, there will come a time when you need to make breaking changes. Having a published strategy in place will help your users migrate the change. Table of Contents: Policy Deprecation Warnings C C++ Python Related Topics Further Reading Policy We recommend setting a public deprecation policy for your systems so that users know what to expect. …
Continue reading “Strategy for Deprecation & Breaking Compatibility”
14 November 2019 by Phillip Johnston • Last updated 14 October 2021 Linking is the process by which object files and libraries are assembled into libraries and binaries. Table of Contents: Related Topics About Linkers and the Linking Process Linking Flags Common Linking Errors Related Topics A compiler is used to create the object files (and potentially the libraries) used by the linker. The linker cnosumes static libraries and shared libraries. About Linkers and the Linking Process For general information about linkers and the linking process: Wikipedia: Linker Linkers and Loaders, by John Levine, is a comprehensive book on compilation, …
14 November 2019 by Phillip Johnston • Last updated 14 December 2021 Compilation is the initial step in the process of constructing a program. Compilation uses source files as inputs. The outputs of a compilation process can be binaries, libraries, object files, assembler files, or other intermediate formats. Table of Contents: Related Topics About Compilers and the Compilation Process Tutorials Compilation Flags A Note on Filename Suffixes Related Topics The linker is used in conjunction with the compiler to produce programs. The compiler can be used to create static libraries and shared libraries. About Compilers and the Compilation Process For …
Continue reading “Compilation”
30 October 2019 by Phillip Johnston • Last updated 9 October 2024 Problem statement: code is not the only thing that matters. Why Documentation Matters Fundamentally, without documentation, nobody will know how to use your software. Even worse, in a couple of months you won’t know how to use your software either – especially if key members of the team depart. Documentation is valuable for many other reasons: Documentation is scalable, personal support is not. The efforts of an individual or group can be referenced by any number of individuals, reducing the support burden. Documentation can be used to aid training …
Continue reading “Documentation”