Merge lp:~lazypower/charms/trusty/mellanox/readme_formatting into lp:charms/trusty/mellanox

Proposed by Charles Butler
Status: Merged
Merged at revision: 8
Proposed branch: lp:~lazypower/charms/trusty/mellanox/readme_formatting
Merge into: lp:charms/trusty/mellanox
Diff against target: 98 lines (+29/-18)
1 file modified
README.md (+29/-18)
To merge this branch: bzr merge lp:~lazypower/charms/trusty/mellanox/readme_formatting
Reviewer Review Type Date Requested Status
charmers Pending
Review via email: mp+245992@code.launchpad.net

Description of the change

Some minor readme formatting

To post a comment you must log in.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'README.md'
2--- README.md 2015-01-08 23:38:50 +0000
3+++ README.md 2015-01-09 18:04:22 +0000
4@@ -1,8 +1,19 @@
5 #Overview
6-The Mellanox charm installs the Mellanox Ethernet driver software and configures it to enable maximum performance for a Mellanox Ethernet adapter. The charm will also program the adapter firmware if the adapter is standard. If it is not standard one will need to program it outside the charm for that you can download the Mellanox Firmware Tool at the following URL [Mellanox Firmware tools](http://www.mellanox.com/page/management_tools).
7+The Mellanox charm installs the Mellanox Ethernet driver software and configures it to enable
8+maximum performance for a Mellanox Ethernet adapter. The charm will also program the adapter
9+firmware if the adapter is standard. If it is not standard one will need to program it outside
10+the charm for that you can download the Mellanox Firmware Tool at the following URL
11+[Mellanox Firmware tools](http://www.mellanox.com/page/management_tools).
12
13 ## About Mellanox:
14-Mellanox Technologies (NASDAQ: MLNX) is a leading supplier of end-to-end InfiniBand and Ethernet interconnect solutions and services for servers and storage. Mellanox interconnect solutions increase data center efficiency by providing the highest throughput and lowest latency, delivering data faster to applications and unlocking system performance capability. Mellanox offers a choice of fast interconnect products: adapters, switches, software and silicon that accelerate application runtime and maximize business results for a wide range of markets including high performance computing, enterprise data centers, Web 2.0, cloud, storage and financial services. More information is available at [Mellanox](www.mellanox.com).
15+Mellanox Technologies (NASDAQ: MLNX) is a leading supplier of end-to-end InfiniBand and Ethernet
16+interconnect solutions and services for servers and storage. Mellanox interconnect solutions
17+increase data center efficiency by providing the highest throughput and lowest latency, delivering
18+data faster to applications and unlocking system performance capability. Mellanox offers a choice
19+of fast interconnect products: adapters, switches, software and silicon that accelerate application
20+runtime and maximize business results for a wide range of markets including high performance
21+computing, enterprise data centers, Web 2.0, cloud, storage and financial services. More information
22+is available at [Mellanox](www.mellanox.com).
23
24 Founded in 1999, Mellanox Technologies is headquartered in Sunnyvale, California and Yokneam, Israel.
25
26@@ -13,11 +24,11 @@
27
28 juju deploy mellanox
29
30-Before the Mellanox software can be installed one must explicitly accept the
31-Mellanox software license (that can be found in the Mellanox_license.txt in the
32-charm folder). To accept the Mellanox license, set the configuration option
33-`accept-mellanox-license` to True. Changing the configuration
34-options can be done from the Juju GUI or from the command line:
35+Before the Mellanox software can be installed one must explicitly accept the Mellanox software
36+license (that can be found in the [Mellanox_license.txt](http://bazaar.launchpad.net/~charmers/charms/trusty/mellanox/trunk/view/head:/Mellanox_license.txt)
37+in the charm directory). To accept the Mellanox license, set the configuration option
38+`accept-mellanox-license` to True. Changing the configuration options can be done from the Juju GUI
39+or from the command line:
40
41 juju set mellanox accept-mellanox-license=True
42
43@@ -37,9 +48,9 @@
44
45 ## Power hardware (ppc)
46
47-The Mellanox charm defaults to the PowerPC version in `config.yaml` file.
48+The Mellanox charm defaults to the PowerPC version in `config.yaml` file.
49 To change the version of popc64le Mellanox software installed you must change
50-the `ofed-file` and the `md5sum` configuration options:
51+the `ofed-file` and the `md5sum` configuration options:
52
53 juju set mellanox ofed-file=MLNX_OFE enteredD_LINUX-(version)-ubuntu14.04-ppc64le.tgz
54 juju set mellanox md5sum=(md5sum of the version)
55@@ -51,14 +62,14 @@
56 ### Deploy using a configuration file
57
58 Alternately a configuration YAML file can be passed on deployment. Create a
59-YAML file that contains the following content:
60+YAML file that contains the following content:
61
62 mellanox:
63 accept-mellanox-license: True
64 ofed-file: "MLNX_OFED_LINUX-2.3-2.0.0-ubuntu14.04-x86_64.tgz"
65 md5sum: "0985c1a6d991b1169e32bebe2c146980"
66
67-Then deploy the Mellanox charm with this configuration file:
68+Then deploy the Mellanox charm with this configuration file:
69
70 juju deploy mellanox --config mellanox_x86.yaml
71
72@@ -67,7 +78,7 @@
73 Finally, the Mellanox charm must be related to another charm. The Mellanox
74 charm is what is known as a subordinate charm, meaning it does not get its
75 own container (or machine). For this charm to function correctly it must be
76-related to a container (machine) with a Mellanox Ethernet adpter.
77+related to a container (machine) with a Mellanox Ethernet adpter.
78
79 juju add-relation mellanox <target-charm>
80
81@@ -82,11 +93,11 @@
82
83 # Contact Information
84
85-Yael Leventer <yaell@mellanox.com>
86-Nurit Vilosny <nuritv@mellanox.com>
87+Yael Leventer <yaell@mellanox.com>
88+Nurit Vilosny <nuritv@mellanox.com>
89
90 ## Mellanox
91-- [Mellanox](http://www.mellanox.com)
92-- [Mellanox Drivers](http://www.mellanox.com/page/products_dyn?product_family=26&mtag=linux_sw_drivers)
93-- [Mellanox Drivers support matrix](http://www.mellanox.com/page/mlnx_ofed_matrix?mtag=linux_sw_drivers)
94-- [Mellanox Adapters](http://www.mellanox.com/page/software_overview_ib>)
95+- [Mellanox](http://www.mellanox.com)
96+- [Mellanox Drivers](http://www.mellanox.com/page/products_dyn?product_family=26&mtag=linux_sw_drivers)
97+- [Mellanox Drivers support matrix](http://www.mellanox.com/page/mlnx_ofed_matrix?mtag=linux_sw_drivers)
98+- [Mellanox Adapters](http://www.mellanox.com/page/software_overview_ib>)

Subscribers

People subscribed via source and target branches

to all changes: