Dave Developer's Wiki Conventions

From DAVE Developer's Wiki
Jump to: navigation, search

Keeping updated on DAVE Embedded Systems Developer's wiki pages modifications

RSS Feeds

In order to keep customers updated on DAVE Embedded Systems Developer's wiki new pages or modified information, all the updates are aggregated and made available using a RSS (Rich Site Summary) feed. RSS feeds can be read using RSS feed "readers" or "aggregators". Once the user subscribes to a feed (for example by clicking a feed icon in a web browser that supports RSS), the RSS reader checks the user's subscribed feeds regularly for any updates that it finds, and provides a user interface to monitor and read the feeds. The following page shows an example of feed aggregation:


Dev-wiki-rss.png

Each entry on this page represents a page modification, with a link to the modified page and a link to a page that summarizes the differences between the previous and recent version.

Please read the RSS info page on Wikipedia to learn more on the Rich Site Summary web feed format.

Where to find RSS feeds

RSS feeds can be accessed from some particular wiki pages, e.g. the Category pages dedicated to the CPU modules. For example, the feed related to the Naon CPU module can be found in the Naon category page (in the Naon RSS Feed section).

How to subscribe to a RSS feed

The following procedure describes how to subscribe to a RSS feed using the Sage extension for the Firefox browser:

  1. Install the Sage Firefox extension selecting Tools->Add-ons on the Firefox menù bar and searching "Sage" as Add-on

  2. Restart Firefox to enable Sage and click to the "Leaf" icon close to the address bar
    Sage-01.png

  3. Click on the RSS feed you want to subscribe to (for example Naon Pages Updates from the Naon Category page)

  4. Drag the address icon from the Firefox address bar to the Sage left panel
    Sage-02.png

  5. Click on the feed bookmark on the Sage left panel to read the news related to wiki pages updates:
    Sage-03.png

Page content remarks

Board/Application Specific Information

When reading a general topic, user can see a section like that starts or include a warning like the following


Info-icon.png The text should explain which specific system or family we are talking about Info-icon.png

In this case everything written inside the box and/or it's containing section should not be applied generically to the main topic but only to a specific target.

Page content specific formats

Terminal Output

Command/Output on embedded device (usually sent/received via telnet or serial console) looks like the following:

U-Boot 2010.06-dirty (Apr 27 2012 - 18:58:24) [nelk-0.9.0-min]

TI8148-GP rev 2.1

ARM clk: 600MHz
DDR clk: 333MHz

DRAM:  512 MiB
Using default environment

Hit any key to stop autoboot:  0
8192 KiB AT45DB642D at 0:0 is now current device
## Starting application at 0x81000000 ...

On the other side, command/output sent/received on user development machine (e.g. DAVE Embedded Systems Virtual Development Kit) looks like:

ezsdk@ezsdk:/home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15$ sudo make omx_install
install -d /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/../rfs/nelk/usr/share/ti/ti-omx
for i in `find /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/component-sources/omx-ti81xx-src_05_02_00_30/bin -name "*.xv5T"`; do \
		install $i /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/../rfs/nelk/usr/share/ti/ti-omx; \
	done
install -d /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/../rfs/nelk/usr/lib
install /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/component-sources/omx-ti81xx-src_05_02_00_30/lib/libtiomx.so.5.2 /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/../rfs/nelk/usr/lib/libtiomx.so.5.2
ln -sf libtiomx.so.5.2 /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/../rfs/nelk/usr/lib/libtiomx.so.5
ln -sf libtiomx.so.5.2 /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/../rfs/nelk/usr/lib/libtiomx.so
ln -sf libtiomx.so.5.2 /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/../rfs/nelk/usr/lib/libOMX_Core.so
ln -sf libtiomx.so.5.2 /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/../rfs/nelk/usr/lib/libOMX_Core
install /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/component-sources/omx-ti81xx-src_05_02_00_30/src/utilities/firmware_loader/firmware_loader /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/../rfs/nelk/usr/bin/firmware_loader
for i in `find /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/component-sources/omx-ti81xx-src_05_02_00_30/src/utilities/firmware_loader/mm_host_util -name "*.bin"`; do \
                install $i /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/../rfs/nelk/usr/share/ti/ti-media-controller-utils; \
        done
install /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/component-sources/omx-ti81xx-src_05_02_00_30/src/utilities/sys_top/sys_top /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/../rfs/nelk/usr/bin/sys_top
install /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/component-sources/omx-ti81xx-src_05_02_00_30/bin/dm814xbm/bin/ti814x-evm/dm814xbm_m3vpss_whole_program_debug.xem3 /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/../rfs/nelk/usr/share/ti/ti-media-controller-utils/dm814x_hdvpss.xem3
install /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/component-sources/omx-ti81xx-src_05_02_00_30/bin/dm814xbm/bin/ti814x-evm/dm814xbm_m3video_whole_program_debug.xem3 /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/../rfs/nelk/usr/share/ti/ti-media-controller-utils/dm814x_hdvicp.xem3
install /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/component-sources/omx-ti81xx-src_05_02_00_30/bin/dm81xx/bin/ti814x-evm/dm81xx_c6xdsp_debug.xe674 /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/../rfs/nelk/usr/share/ti/ti-media-controller-utils/dm81xx_c6xdsp.xe674
/home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/media-controller-devkit/cgt470_4_9_2/bin/strip470 /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/../rfs/nelk/usr/share/ti/ti-media-controller-utils/dm814x_hdvpss.xem3
/home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/media-controller-devkit/cgt470_4_9_2/bin/strip470 /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/../rfs/nelk/usr/share/ti/ti-media-controller-utils/dm814x_hdvicp.xem3
/home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/dsp-devkit/cgt6x_7_3_1/bin/strip6x /home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15/../rfs/nelk/usr/share/ti/ti-media-controller-utils/dm81xx_c6xdsp.xe674
ezsdk@ezsdk:/home/shared/devel/dave/naon-DAA/sw/linux/sdk/sdk-5.03.01.15$