intel / arduino101_manifest Goto Github PK

• Get a list of Makefiles and configuration files used by the build mechanism
• Identify all the variables used/defined by those files and try to get rid of as many as possible.
• Check what implications has at the code level defining/undefining the remaining variables. We might see at this stage that we need to bring back some of the directories removed during previous steps

• Remove all the unused git repositories (Already started by San Diego lads).
• Create a list of source files which are compiled by the firmware build mechanism (not headers files)
  • Using "strace" tool and V=1 option of make tool.
• Trim as much as possible of the source code tree based on the output of the previous step (list of file used by the build mechanism)

• Create a list of code-names which need to be replaced
• Replace the code-names
  • one at the time or
  • all of them in a bulk work session

Calvin, could you, please, have a look at below commit and see if you're OK with the list of files alreday removed: https://github.com/01org/arduino101_main/commit/98389f5e2c4ef529a109576cd6b75b255b30850c

Following is the list of remaining files. We need to decide if we keep them or not:

• doc/build_config.md
  • Documents how to create a custom build configuration (has references to TARGET_menuconfig targets, which are removed)
  • Should we remove this document?
• doc/build_kbuild.md
  • Project source tree - describes briefly the build system (borrowed from Linux kernel)
  • Should we remove it?
• doc/device.md
  • Document the device tree and how to integrate a new device driver in the tree
  • I would keep it.
• doc/gpio_service.md
  • Documents the SoC GPIOs and the corresponding CFW services
  • I would keep it because the GPIO service/driver are still included in the build
• doc/panic.md
  • Documents the panic mechanism - I would keep it;
  • The last paragraph (or whatever is that) needs a bit of rework; it doesn't look good
• doc/pm.md
  • Documents the platform power management; it needs a bit of rework/review - I don't think it looks as it should
  • I would keep it because the pm code is in the bundle
• doc/images/
  • All images except device_tree.png (referenced by device.md file) and logo.png (referenced by build/common_targets.mk)deleted
• doc/build_onetimesetup.md
  • Describes one_time_setup make target: A special target available on the SDK common targets has been created for that purpose. It must be run only once, with superuser privileges: sudo make one_time_setup

Need a user guide:

1. Where to download (link should be updated once the source is uploaded to Download Center)
2. Install the build dependencies
3. Make commands to create the firmware
4. Make commands to create the flash pack
5. How to use the flash pack

• One option would be to parse all used source files (*.c and *.S) and collect all #include directives
• Another option: investigate a bit the power of make/gcc to check if it can give this list.

• An automated smoke test session should do it
• It depends on the coverage provided by the currently automated test cases

• What about any other non-code files (e.g. documentation, makefiles, configuration files): do they have to have a license header as well?

[Bogdan]: Can be covered by a license file in the root directory, according to Larry