Pages which need to be written/updated for OE5

From wiki.emacinc.com
Revision as of 17:15, 6 November 2014 by Mdean (talk | contribs) (File Tools: Fixed typo)
Jump to: navigation, search

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.


Important

  • Add a "Related Content" section to the bottom of every document, to guide people to other helpful information.
  • Link to related hardware on our sales website (www)
  • See about updating the appearance of the wiki to more closely match the main website




Things to document for OE5:


Tasks

  • How to configure screen blanking (console) time (change consoleblank value in kernel commandline to number of seconds, or 0 for never)

Tools

File Tools
  • inotify{wait,watch}
  • file
  • look - example using logs
  • flock, lslocks
  • lsblk
  • findmnt
  • fuser
  • md5sum
  • mkfifo
  • namei
  • install
Network Tools
  • ethtool
  • wget
  • wput
  • ftpget
  • ftpput
  • sshpass
  • dig
Audio Tools
  • alsactl
  • alsamixer
  • alsaloop
  • amixer
  • aplay
  • arecord
  • mpg123
  • speaker-test
Graphics Tools
  •  ???
Miscellaneous Tools
  • logger
  • free
  • ps* df, discus, du
  • tload
  • runscript - minicom scripting tool
  • opkg install/update/etc
  • evtest
  • makehrtf - either document or remove this utility

Drivers

Working with the sysfs interface
  • Working with EGPIO
  • ECOREEX
  • EMAC A/D and D/A
  • Backlight
  • /sys/class/net/eth0/{address,duplex,speed,statistics/{tx_,rx_}{bytes,packets,errors}}

System

Working with /proc
  • /proc/config.gz
  • /proc/cpuinfo
  • /proc/swaps
  • /proc/loadavg
  • /proc/partitions
  • /proc/version
  • /proc/uptime
  • /proc/net/dev
  • /proc/filesystems
  • /proc/fs/nfsfs/{servers,volumes}
  • /proc/number

Desktop SDK/Tools

  • apt-get install/etc
  • Qt Creator
  • CMake - using from the command line
  • git - using with git.emacinc.com
  • Automation Tools
  • EMAC Drivers
  • EMAC Examples

Revise

  • Update FAQ
  • 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
  • EMAC OE Add-on Packages
  • Add more content to the Graphics section
  • 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"
  • 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.
  • "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
  • "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
  • "Repartitioning a CompactFlash Disk for Linux" - filesystem type needs to be changed.
  • "Quick Reference" - add more content...
    • ln
    • top/htop
    • df
    • du
    • ntp{d,q}
    • vim
    • ctags
    • permanent network config changes
    • nfs mounts
    • rsync
    • tcpdump
    • head/tail/look
    • grep/egrep/fgrep
    • uptime
    • lsof
    • who/w
    • which
    • whatis
    • whereis
    • whois
    • whoami/$UID/$GID/groups/id
    • dirs/pushd/popd
    • ps
    • globs
    • date
    • tar
    • touch
    • bash functions
    • bc
    • xargs
    • kill
    • diff
    • echo/printf/cat/pipes
    • mkfifo
    • {,c,s}fdisk
    • mkswap/mkfs.ext{2,3,4}
    • strings
    • {l,s}trace
    • /etc/services
    • wc

Pages to Enhance and Tweak

  • "Mounting JFFS2 Images on a Linux PC"
  • "Loading Images onto eMMC Devices"
  • "Repartitioning NAND Flash with JFFS2 for Linux"
  • "Remote System Explorer SFTP Setup for Eclipse" - advertise EMAC products here
  • "Booting with an NFS Root Filesystem"
  • "Loading Images with U-Boot"
  • "Creating JFFS2 Images"
  • "Loading Images with Redboot"
  • "EMAC OE USB Gadget Connections"
  • "U-Boot Overview"
  • "Repartitioning a CompactFlash Disk for Linux"
  • "Installing a TFTP Server"

Main Page - We need to steer people to the Main Page as much as possible, and make the Main Page apealing.