Difference between revisions of "Pages which need to be written/updated for OE5"
m (→Main Page - We need to steer people to the Main Page as much as possible, and make the Main Page appealing.) |
m (Prioritized) |
||
| Line 11: | Line 11: | ||
* '''Make sure all pages follow standard layout (with the review process)''' | * '''Make sure all pages follow standard layout (with the review process)''' | ||
* '''SEO Keywords need to be put on every page.''' | * '''SEO Keywords need to be put on every page.''' | ||
| + | |||
| + | === KEY === | ||
| + | |||
| + | The following tags indicate the release for which the item needs to be completed. If an item doesn't have a tag, then it must be completed for the next release (release 1, currently). | ||
| + | |||
| + | * (r1) - Release 1 | ||
| + | * (r2) - Release 2 | ||
| + | * (r3) - Release 3 | ||
| + | * (r4) - Release 4 | ||
==== Important ==== | ==== Important ==== | ||
| − | |||
| − | |||
* See about updating the appearance of the wiki to more closely match the main website | * See about updating the appearance of the wiki to more closely match the main website | ||
| + | * (r2) Add a "Related Content" section to the bottom of every document, to guide people to other helpful information. | ||
| + | |||
| + | * (r3) Link to related hardware on our sales website (www) | ||
| + | |||
| + | =='''Main Page - We need to steer people to the Main Page as much as possible, and make the Main Page appealing.'''== | ||
---- | ---- | ||
| Line 30: | Line 42: | ||
==== Tasks ==== | ==== Tasks ==== | ||
| − | * How to configure screen blanking (console) time (change consoleblank value in kernel commandline to number of seconds, or 0 for never) | + | * (r3) How to configure screen blanking (console) time (change consoleblank value in kernel commandline to number of seconds, or 0 for never) |
==== Tools ==== | ==== Tools ==== | ||
| Line 36: | Line 48: | ||
===== File Tools ===== | ===== File Tools ===== | ||
| − | * inotify{wait,watch} | + | * (r3) inotify{wait,watch} |
| − | * file | + | * (r4) file |
| − | * look - example using logs | + | * (r4) look - example using logs |
| − | * flock, lslocks | + | * (r4) flock, lslocks |
| − | * lsblk | + | * (r4) lsblk |
| − | * findmnt | + | * (r4) findmnt |
| − | * fuser | + | * (r4) fuser |
| − | * md5sum | + | * (r4) md5sum |
| − | * mkfifo | + | * (r4) mkfifo |
| − | * namei | + | * (r4) namei |
| − | * install | + | * (r4) install |
===== Network Tools ===== | ===== Network Tools ===== | ||
| − | * ethtool | + | * (r2) ethtool |
| − | * wget | + | * (r4) wget |
| − | * wput | + | * (r4) wput |
| − | * ftpget | + | * (r4) ftpget |
| − | * ftpput | + | * (r4) ftpput |
| − | * sshpass | + | * (r4) sshpass |
| − | * dig | + | * (r4) dig |
===== Audio Tools ===== | ===== Audio Tools ===== | ||
| − | * alsactl | + | * (r2) alsactl |
| − | * alsamixer | + | * (r2) alsamixer |
| − | * alsaloop | + | * (r2) alsaloop |
| − | * amixer | + | * (r2) amixer |
| − | * aplay | + | * (r2) aplay |
| − | * arecord | + | * (r2) arecord |
| − | * mpg123 | + | * (r2) mpg123 |
| − | * speaker-test | + | * (r2) speaker-test |
| − | * /usr/share/emac/audio | + | * (r2) /usr/share/emac/audio |
===== Graphics Tools ===== | ===== Graphics Tools ===== | ||
| − | * /etc/resolution | + | * (r2) /etc/resolution |
| − | * fbi | + | * (r2) fbi |
| − | * /usr/share/emac/graphics | + | * (r2) /usr/share/emac/graphics |
* ??? | * ??? | ||
===== Miscellaneous Tools ===== | ===== Miscellaneous Tools ===== | ||
| − | * logger | + | * (r4) logger |
| − | * free | + | * (r4) free |
| − | * ps | + | * (r4) ps |
| − | * df, discus, du | + | * (r4) df, discus, du |
| − | * tload | + | * (r3) tload |
| − | * runscript - minicom scripting tool | + | * (r3) runscript - minicom scripting tool |
| − | * opkg install/update/etc | + | * (r1) opkg install/update/etc |
| − | * evtest | + | * (r4) evtest |
| − | * makehrtf - either document or remove this utility | + | * (r3) makehrtf - either document or remove this utility |
==== Drivers ==== | ==== Drivers ==== | ||
| Line 93: | Line 105: | ||
===== Working with the sysfs interface ===== | ===== Working with the sysfs interface ===== | ||
| − | * Working with EGPIO | + | * (r2) Working with EGPIO |
| − | * ECOREEX | + | * (r2) ECOREEX |
| − | * EMAC A/D and D/A | + | * (r2) EMAC A/D and D/A |
| − | * Backlight | + | * (r2) Backlight |
| − | * /sys/class/net/eth0/{address,duplex,speed,statistics/{tx_,rx_}{bytes,packets,errors}} | + | * (r2) /sys/class/net/eth0/{address,duplex,speed,statistics/{tx_,rx_}{bytes,packets,errors}} |
==== System ==== | ==== System ==== | ||
| Line 103: | Line 115: | ||
===== Working with /proc ===== | ===== Working with /proc ===== | ||
| − | * /proc/config.gz | + | * (r2) /proc/config.gz |
| − | * /proc/cpuinfo | + | * (r4) /proc/cpuinfo |
| − | * /proc/swaps | + | * (r4) /proc/swaps |
| − | * /proc/loadavg | + | * (r4) /proc/loadavg |
| − | * /proc/partitions | + | * (r4) /proc/partitions |
| − | * /proc/version | + | * (r4) /proc/version |
| − | * /proc/uptime | + | * (r4) /proc/uptime |
| − | * /proc/net/dev | + | * (r4) /proc/net/dev |
| − | * /proc/filesystems | + | * (r4) /proc/filesystems |
| − | * /proc/fs/nfsfs/{servers,volumes} | + | * (r4) /proc/fs/nfsfs/{servers,volumes} |
| − | * /proc/''number'' | + | * (r2) /proc/''number'' |
==== Desktop SDK/Tools ==== | ==== Desktop SDK/Tools ==== | ||
| − | * apt-get install/etc | + | * (r1) apt-get install/etc |
| − | * Qt Creator | + | * (r1) Qt Creator |
| − | * CMake - using from the command line | + | * (r1) CMake - using from the command line |
| − | * git - using with git.emacinc.com | + | * (r1) git - using with git.emacinc.com |
| − | * Automation Tools | + | * (r1) Automation Tools |
| − | * EMAC Drivers | + | * (r1) EMAC Drivers |
| − | * EMAC Examples | + | * (r1) EMAC Examples |
==== Revise ==== | ==== Revise ==== | ||
| − | * Update FAQ | + | * (r2) Update FAQ |
| − | * About Linux - Add more Info | + | * (r4) About Linux - Add more Info |
| − | * Getting Started with EMAC Embedded Linux Development - Update with links for 5.0, change Eclipse parts to Qt Creator, etc | + | * (r1) Getting Started with EMAC Embedded Linux Development - Update with links for 5.0, change Eclipse parts to Qt Creator, etc |
| − | * EMAC OE Add-on Packages | + | * (r1) EMAC OE Add-on Packages |
| − | * Add more content to the Graphics section | + | * (r3) Add more content to the Graphics section |
| − | * Serial Connections - Add 9x25 info, remove boards without OE5 support from table | + | * (r1) Serial Connections - Add 9x25 info, remove boards without OE5 support from table |
| − | * Network Configuration - Remove "Disabling Telnet" and add info about ethtool; remove "telnet is enabled by default" | + | * (r1) Network Configuration - Remove "Disabling Telnet" and add info about ethtool; remove "telnet is enabled by default" |
| − | * Make the next steps more clear in, "Archiving JFFS2 Images" | + | * (r2) Make the next steps more clear in, "Archiving JFFS2 Images" |
| − | * For, "Creating JFFS2 Images," an Overview needs to be added which simply and clearly describes the pieces and process. | + | * (r2) For, "Creating JFFS2 Images," an Overview needs to be added which simply and clearly describes the pieces and process. |
| − | * "Editing a File" needs to be revised with info about vim. | + | * (r3) "Editing a File" needs to be revised with info about vim. |
| − | * "Creating a New EMAC OE SDK Project" needs to be revised with CMake info | + | * (r1) "Creating a New EMAC OE SDK Project" needs to be revised with CMake info |
| − | * "Building the Linux Kernel" needs to be rev'd with OE5 relevant info | + | * (r1) "Building the Linux Kernel" needs to be rev'd with OE5 relevant info |
| − | * "EMAC OE Development Process" needs to reference Qt Creator instead of Eclipse | + | * (r1) "EMAC OE Development Process" needs to reference Qt Creator instead of Eclipse |
| − | * "Repartitioning a CompactFlash Disk for Linux" - filesystem type needs to be changed. | + | * (r1) "Repartitioning a CompactFlash Disk for Linux" - filesystem type needs to be changed. |
| − | * "Quick Reference" - add more content... | + | * (r4) "Quick Reference" - add more content... |
| − | ** ln | + | ** (r4) ln |
| − | ** top/htop | + | ** (r4) top/htop |
| − | ** df | + | ** (r4) df |
| − | ** du | + | ** (r4) du |
| − | ** ntp{d,q} | + | ** (r4) ntp{d,q} |
| − | ** vim | + | ** (r4) vim |
| − | ** ctags | + | ** (r4) ctags |
| − | ** permanent network config changes | + | ** (r2) permanent network config changes |
| − | ** nfs mounts | + | ** (r3) nfs mounts |
| − | ** rsync | + | ** (r4) rsync |
| − | ** tcpdump | + | ** (r3) tcpdump |
| − | ** head/tail/look | + | ** (r4) head/tail/look |
| − | ** grep/egrep/fgrep | + | ** (r4) grep/egrep/fgrep |
| − | ** uptime | + | ** (r4) uptime |
| − | ** lsof | + | ** (r4) lsof |
| − | ** who/w | + | ** (r4) who/w |
| − | ** which | + | ** (r4) which |
| − | ** whatis | + | ** (r4) whatis |
| − | ** whereis | + | ** (r4) whereis |
| − | ** whois | + | ** (r4) whois |
| − | ** whoami/$UID/$GID/groups/id | + | ** (r4) whoami/$UID/$GID/groups/id |
| − | ** dirs/pushd/popd | + | ** (r4) dirs/pushd/popd |
| − | ** ps | + | ** (r4) ps |
| − | ** globs | + | ** (r4) globs |
| − | ** date | + | ** (r4) date |
| − | ** tar | + | ** (r4) tar |
| − | ** touch | + | ** (r4) touch |
| − | ** bash functions | + | ** (r4) bash functions |
| − | ** bc | + | ** (r4) bc |
| − | ** xargs | + | ** (r4) xargs |
| − | ** kill | + | ** (r4) kill |
| − | ** diff | + | ** (r4) diff |
| − | ** echo/printf/cat/pipes | + | ** (r4) echo/printf/cat/pipes |
| − | ** mkfifo | + | ** (r4) mkfifo |
| − | ** {,c,s}fdisk | + | ** (r4) {,c,s}fdisk |
| − | ** mkswap/mkfs.ext{2,3,4} | + | ** (r4) mkswap/mkfs.ext{2,3,4} |
| − | ** strings | + | ** (r4) strings |
| − | ** {l,s}trace | + | ** (r4) {l,s}trace |
| − | ** /etc/services | + | ** (r4) /etc/services |
| − | ** wc | + | ** (r4) wc |
==== Pages to Enhance and Tweak ==== | ==== Pages to Enhance and Tweak ==== | ||
| − | * "Mounting JFFS2 Images on a Linux PC" | + | * (r2) "Mounting JFFS2 Images on a Linux PC" |
| − | * "Loading Images onto eMMC Devices" | + | * (r1) "Loading Images onto eMMC Devices" |
| − | * "Repartitioning NAND Flash with JFFS2 for Linux" | + | * (r1) "Repartitioning NAND Flash with JFFS2 for Linux" |
| − | * "Remote System Explorer SFTP Setup for Eclipse" - advertise EMAC products here | + | * (r3) "Remote System Explorer SFTP Setup for Eclipse" - advertise EMAC products here |
| − | * "Booting with an NFS Root Filesystem" | + | * (r1) "Booting with an NFS Root Filesystem" |
| − | * "Loading Images with U-Boot" | + | * (r1) "Loading Images with U-Boot" |
| − | * "Creating JFFS2 Images" | + | * (r2) "Creating JFFS2 Images" |
| − | * "Loading Images with Redboot" | + | * (r3) "Loading Images with Redboot" |
| − | * "EMAC OE USB Gadget Connections" | + | * (r2) "EMAC OE USB Gadget Connections" |
| − | * "U-Boot Overview" | + | * (r2) "U-Boot Overview" |
| − | * "Repartitioning a CompactFlash Disk for Linux" | + | * (r1) "Repartitioning a CompactFlash Disk for Linux" |
| − | * "Installing a TFTP Server" | + | * (r3) "Installing a TFTP Server" |
| − | |||
| − | |||
Revision as of 22:00, 6 November 2014
Contents
- 1 Tasks Needed to Release the OE 5.0 Docs and Tasks Which Will Improve the Site:
- 2 KEY
- 3 Main Page - We need to steer people to the Main Page as much as possible, and make the Main Page appealing.
Tasks Needed to Release the OE 5.0 Docs and Tasks Which Will Improve the Site:
Essential
- Create new page naming scheme to handle distinction between content for 4.0, 5.0, 5.1, etc.
- Create new main page which links to the different start pages for the different OE versions.
- Update sidebar with links to different OE version start pages, and to the new main page.
- Create a more rigid, standard layout/format for our wiki pages.
- Make sure all pages follow standard layout (with the review process)
- SEO Keywords need to be put on every page.
KEY
The following tags indicate the release for which the item needs to be completed. If an item doesn't have a tag, then it must be completed for the next release (release 1, currently).
- (r1) - Release 1
- (r2) - Release 2
- (r3) - Release 3
- (r4) - Release 4
Important
- See about updating the appearance of the wiki to more closely match the main website
- (r2) Add a "Related Content" section to the bottom of every document, to guide people to other helpful information.
- (r3) Link to related hardware on our sales website (www)
Main Page - We need to steer people to the Main Page as much as possible, and make the Main Page appealing.
Things to document for OE5:
Tasks
- (r3) How to configure screen blanking (console) time (change consoleblank value in kernel commandline to number of seconds, or 0 for never)
Tools
File Tools
- (r3) inotify{wait,watch}
- (r4) file
- (r4) look - example using logs
- (r4) flock, lslocks
- (r4) lsblk
- (r4) findmnt
- (r4) fuser
- (r4) md5sum
- (r4) mkfifo
- (r4) namei
- (r4) install
Network Tools
- (r2) ethtool
- (r4) wget
- (r4) wput
- (r4) ftpget
- (r4) ftpput
- (r4) sshpass
- (r4) dig
Audio Tools
- (r2) alsactl
- (r2) alsamixer
- (r2) alsaloop
- (r2) amixer
- (r2) aplay
- (r2) arecord
- (r2) mpg123
- (r2) speaker-test
- (r2) /usr/share/emac/audio
Graphics Tools
- (r2) /etc/resolution
- (r2) fbi
- (r2) /usr/share/emac/graphics
- ???
Miscellaneous Tools
- (r4) logger
- (r4) free
- (r4) ps
- (r4) df, discus, du
- (r3) tload
- (r3) runscript - minicom scripting tool
- (r1) opkg install/update/etc
- (r4) evtest
- (r3) makehrtf - either document or remove this utility
Drivers
Working with the sysfs interface
- (r2) Working with EGPIO
- (r2) ECOREEX
- (r2) EMAC A/D and D/A
- (r2) Backlight
- (r2) /sys/class/net/eth0/{address,duplex,speed,statistics/{tx_,rx_}{bytes,packets,errors}}
System
Working with /proc
- (r2) /proc/config.gz
- (r4) /proc/cpuinfo
- (r4) /proc/swaps
- (r4) /proc/loadavg
- (r4) /proc/partitions
- (r4) /proc/version
- (r4) /proc/uptime
- (r4) /proc/net/dev
- (r4) /proc/filesystems
- (r4) /proc/fs/nfsfs/{servers,volumes}
- (r2) /proc/number
Desktop SDK/Tools
- (r1) apt-get install/etc
- (r1) Qt Creator
- (r1) CMake - using from the command line
- (r1) git - using with git.emacinc.com
- (r1) Automation Tools
- (r1) EMAC Drivers
- (r1) EMAC Examples
Revise
- (r2) Update FAQ
- (r4) About Linux - Add more Info
- (r1) Getting Started with EMAC Embedded Linux Development - Update with links for 5.0, change Eclipse parts to Qt Creator, etc
- (r1) EMAC OE Add-on Packages
- (r3) Add more content to the Graphics section
- (r1) Serial Connections - Add 9x25 info, remove boards without OE5 support from table
- (r1) Network Configuration - Remove "Disabling Telnet" and add info about ethtool; remove "telnet is enabled by default"
- (r2) Make the next steps more clear in, "Archiving JFFS2 Images"
- (r2) For, "Creating JFFS2 Images," an Overview needs to be added which simply and clearly describes the pieces and process.
- (r3) "Editing a File" needs to be revised with info about vim.
- (r1) "Creating a New EMAC OE SDK Project" needs to be revised with CMake info
- (r1) "Building the Linux Kernel" needs to be rev'd with OE5 relevant info
- (r1) "EMAC OE Development Process" needs to reference Qt Creator instead of Eclipse
- (r1) "Repartitioning a CompactFlash Disk for Linux" - filesystem type needs to be changed.
- (r4) "Quick Reference" - add more content...
- (r4) ln
- (r4) top/htop
- (r4) df
- (r4) du
- (r4) ntp{d,q}
- (r4) vim
- (r4) ctags
- (r2) permanent network config changes
- (r3) nfs mounts
- (r4) rsync
- (r3) tcpdump
- (r4) head/tail/look
- (r4) grep/egrep/fgrep
- (r4) uptime
- (r4) lsof
- (r4) who/w
- (r4) which
- (r4) whatis
- (r4) whereis
- (r4) whois
- (r4) whoami/$UID/$GID/groups/id
- (r4) dirs/pushd/popd
- (r4) ps
- (r4) globs
- (r4) date
- (r4) tar
- (r4) touch
- (r4) bash functions
- (r4) bc
- (r4) xargs
- (r4) kill
- (r4) diff
- (r4) echo/printf/cat/pipes
- (r4) mkfifo
- (r4) {,c,s}fdisk
- (r4) mkswap/mkfs.ext{2,3,4}
- (r4) strings
- (r4) {l,s}trace
- (r4) /etc/services
- (r4) wc
Pages to Enhance and Tweak
- (r2) "Mounting JFFS2 Images on a Linux PC"
- (r1) "Loading Images onto eMMC Devices"
- (r1) "Repartitioning NAND Flash with JFFS2 for Linux"
- (r3) "Remote System Explorer SFTP Setup for Eclipse" - advertise EMAC products here
- (r1) "Booting with an NFS Root Filesystem"
- (r1) "Loading Images with U-Boot"
- (r2) "Creating JFFS2 Images"
- (r3) "Loading Images with Redboot"
- (r2) "EMAC OE USB Gadget Connections"
- (r2) "U-Boot Overview"
- (r1) "Repartitioning a CompactFlash Disk for Linux"
- (r3) "Installing a TFTP Server"
