Wiki

Analog Devices Wiki

English
English
简体中文
简体中文
日本語
日本語
Руccкий
Руccкий
This version (04 May 2021 17:27) was approved by Robin Getz.The Previously approved version (25 Jun 2020 18:53) is available.Diff

Table of Contents

Github at Analog Devices

Analog Devices uses GitHub to distribute source code (and text files that resemble source code) which needed to be maintained.

There are a few Interwiki link shortcuts which can be used to quickly link to specific files in github. These are used to move the wiki reader to the actual code. It's not meant to provide downloads.

  • [[linux.github>branch?path]] translates to http://github.com/analogdevicesinc/linux/blob/{branch}/{path}
    • Example: [[linux.github>master?arch/arm/boot/dts/zynq-adrv9361-z7035-fmc-rfcard-tdd.dts |device tree]] makes device tree in the wiki.
  • [[repo>repository]] translates to http://github.com/analogdevicesinc/{repository}
  • [[github>repository?branch/path]] translates to http://github.com/analogdevicesinc/{repository}/blob/{branch/path}
    • Example: [[github>hdl?hdl_2016_r2/projects/pluto| Files]] creates this link : Files

Downloads

We try not to distribute random zip file on the wiki, but use a on-line service from DownGit by Minhas Kamal to create links in the wiki, that point to github, and allow you to post “live” code as zip file in the wiki. ADI created a custom fork of this project since this was running into issues for many people.

Just go to the DownGit page, and paste the repository (including sub directory) you want to provide, and it will provide a link you can use.

Example

For example, ADI provides a javascript engine in it's scopy application, and maintain examples in the scopy repository, so it can maintained by the software team, and tested on every release. We also make sure that packaging/installers includes them as examples.

On the wiki – for things that are in sub directories of repositories, where you want to provide a zip file for end users, but not have them download the entire repository - just paste the url of the directory - in this case - https://github.com/analogdevicesinc/scopy/tree/master/js into Downgit. This will create a url:

https://analogdevicesinc.github.io/DownGit/#/home?url=https://github.com/analogdevicesinc/scopy/tree/master/js

which can be used in the wiki, like here that way – end users still get the zip file, but the code is maintained in github.

There is also a shortlink for this [[downgit>repo/path/]] which means in the wiki, you can do [[downgit>scopy/tree/master/js|zipfile]] like zipfile, and it will zip up the file, and download it.

If it is just a single file (like the examples), we can just point to the top level directory, and people can download from github what they want.

wiki/github.txt · Last modified: 04 May 2021 17:27 by Robin Getz

Page Tools