Skip to content

Commit 7f22850

Browse files
committed
Normalizing all line endings
Signed-off-by: James Sutton <james.sutton@uk.ibm.com>
1 parent dfcef67 commit 7f22850

110 files changed

Lines changed: 19956 additions & 19957 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CONTRIBUTING.md

Lines changed: 66 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,66 @@
1-
# Contributing to Paho
2-
3-
Thanks for your interest in this project!
4-
5-
You can contribute bugfixes and new features by sending pull requests through GitHub.
6-
7-
## Legal
8-
9-
In order for your contribution to be accepted, it must comply with the Eclipse Foundation IP policy.
10-
11-
Please read the [Eclipse Foundation policy on accepting contributions via Git](http://wiki.eclipse.org/Development_Resources/Contributing_via_Git).
12-
13-
1. Sign the [Eclipse CLA](http://www.eclipse.org/legal/CLA.php)
14-
1. Register for an Eclipse Foundation User ID. You can register [here](https://dev.eclipse.org/site_login/createaccount.php).
15-
2. Log into the [Projects Portal](https://projects.eclipse.org/), and click on the '[Eclipse CLA](https://projects.eclipse.org/user/sign/cla)' link.
16-
2. Go to your [account settings](https://dev.eclipse.org/site_login/myaccount.php#open_tab_accountsettings) and add your GitHub username to your account.
17-
3. Make sure that you _sign-off_ your Git commits in the following format:
18-
``` Signed-off-by: John Smith <johnsmith@nowhere.com> ``` This is usually at the bottom of the commit message. You can automate this by adding the '-s' flag when you make the commits. e.g. ```git commit -s -m "Adding a cool feature"```
19-
4. Ensure that the email address that you make your commits with is the same one you used to sign up to the Eclipse Foundation website with.
20-
21-
## Contributing a change
22-
23-
1. [Fork the repository on GitHub](https://github.com/eclipse/paho.mqtt.java/fork)
24-
2. Clone the forked repository onto your computer: ``` git clone https://github.com/<your username>/paho.mqtt.java.git ```
25-
3. Create a new branch from the latest ```develop``` branch with ```git checkout -b YOUR_BRANCH_NAME origin/develop```
26-
4. Make your changes
27-
5. If developing a new feature, make sure to include JUnit tests.
28-
6. Ensure that all new and existing tests pass.
29-
7. Commit the changes into the branch: ``` git commit -s ``` Make sure that your commit message is meaningful and describes your changes correctly.
30-
8. If you have a lot of commits for the change, squash them into a single / few commits.
31-
9. Push the changes in your branch to your forked repository.
32-
10. Finally, go to [https://github.com/eclipse/paho.mqtt.java](https://github.com/eclipse/paho.mqtt.java) and create a pull request from your "YOUR_BRANCH_NAME" branch to the ```develop``` one to request review and merge of the commits in your pushed branch.
33-
34-
35-
What happens next depends on the content of the patch. If it is 100% authored
36-
by the contributor and is less than 1000 lines (and meets the needs of the
37-
project), then it can be pulled into the main repository. If not, more steps
38-
are required. These are detailed in the
39-
[legal process poster](http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf).
40-
41-
42-
43-
## Developer resources:
44-
45-
46-
Information regarding source code management, builds, coding standards, and more.
47-
48-
- [https://projects.eclipse.org/projects/iot.paho/developer](https://projects.eclipse.org/projects/iot.paho/developer)
49-
50-
Contact:
51-
--------
52-
53-
Contact the project developers via the project's development
54-
[mailing list](https://dev.eclipse.org/mailman/listinfo/paho-dev).
55-
56-
Search for bugs:
57-
----------------
58-
59-
This project uses GitHub Issues here: [github.com/eclipse/paho.mqtt.java/issues](https://github.com/eclipse/paho.mqtt.java/issues) to track ongoing development and issues.
60-
61-
Create a new bug:
62-
-----------------
63-
64-
Be sure to search for existing bugs before you create another one. Remember that contributions are always welcome!
65-
66-
- [Create new Paho bug](https://github.com/eclipse/paho.mqtt.java/issues/new)
1+
# Contributing to Paho
2+
3+
Thanks for your interest in this project!
4+
5+
You can contribute bugfixes and new features by sending pull requests through GitHub.
6+
7+
## Legal
8+
9+
In order for your contribution to be accepted, it must comply with the Eclipse Foundation IP policy.
10+
11+
Please read the [Eclipse Foundation policy on accepting contributions via Git](http://wiki.eclipse.org/Development_Resources/Contributing_via_Git).
12+
13+
1. Sign the [Eclipse CLA](http://www.eclipse.org/legal/CLA.php)
14+
1. Register for an Eclipse Foundation User ID. You can register [here](https://dev.eclipse.org/site_login/createaccount.php).
15+
2. Log into the [Projects Portal](https://projects.eclipse.org/), and click on the '[Eclipse CLA](https://projects.eclipse.org/user/sign/cla)' link.
16+
2. Go to your [account settings](https://dev.eclipse.org/site_login/myaccount.php#open_tab_accountsettings) and add your GitHub username to your account.
17+
3. Make sure that you _sign-off_ your Git commits in the following format:
18+
``` Signed-off-by: John Smith <johnsmith@nowhere.com> ``` This is usually at the bottom of the commit message. You can automate this by adding the '-s' flag when you make the commits. e.g. ```git commit -s -m "Adding a cool feature"```
19+
4. Ensure that the email address that you make your commits with is the same one you used to sign up to the Eclipse Foundation website with.
20+
21+
## Contributing a change
22+
23+
1. [Fork the repository on GitHub](https://github.com/eclipse/paho.mqtt.java/fork)
24+
2. Clone the forked repository onto your computer: ``` git clone https://github.com/<your username>/paho.mqtt.java.git ```
25+
3. Create a new branch from the latest ```develop``` branch with ```git checkout -b YOUR_BRANCH_NAME origin/develop```
26+
4. Make your changes
27+
5. If developing a new feature, make sure to include JUnit tests.
28+
6. Ensure that all new and existing tests pass.
29+
7. Commit the changes into the branch: ``` git commit -s ``` Make sure that your commit message is meaningful and describes your changes correctly.
30+
8. If you have a lot of commits for the change, squash them into a single / few commits.
31+
9. Push the changes in your branch to your forked repository.
32+
10. Finally, go to [https://github.com/eclipse/paho.mqtt.java](https://github.com/eclipse/paho.mqtt.java) and create a pull request from your "YOUR_BRANCH_NAME" branch to the ```develop``` one to request review and merge of the commits in your pushed branch.
33+
34+
35+
What happens next depends on the content of the patch. If it is 100% authored
36+
by the contributor and is less than 1000 lines (and meets the needs of the
37+
project), then it can be pulled into the main repository. If not, more steps
38+
are required. These are detailed in the
39+
[legal process poster](http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf).
40+
41+
42+
43+
## Developer resources:
44+
45+
46+
Information regarding source code management, builds, coding standards, and more.
47+
48+
- [https://projects.eclipse.org/projects/iot.paho/developer](https://projects.eclipse.org/projects/iot.paho/developer)
49+
50+
Contact:
51+
--------
52+
53+
Contact the project developers via the project's development
54+
[mailing list](https://dev.eclipse.org/mailman/listinfo/paho-dev).
55+
56+
Search for bugs:
57+
----------------
58+
59+
This project uses GitHub Issues here: [github.com/eclipse/paho.mqtt.java/issues](https://github.com/eclipse/paho.mqtt.java/issues) to track ongoing development and issues.
60+
61+
Create a new bug:
62+
-----------------
63+
64+
Be sure to search for existing bugs before you create another one. Remember that contributions are always welcome!
65+
66+
- [Create new Paho bug](https://github.com/eclipse/paho.mqtt.java/issues/new)
Lines changed: 102 additions & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -1,102 +1,102 @@
1-
**Project** Eclipse Paho MQTT Tester View
2-
3-
**Version** 1.0.3
4-
5-
**Date** 24-04-2013
6-
7-
**Author** Eurotech Inc.
8-
9-
10-
# Overview
11-
12-
The Eclipse Paho MQTT Tester View is an Eclipse plugin that provides a user interface for performing MQTT-based messaging tasks within Eclipse.
13-
14-
15-
# Installation
16-
17-
(TODO this section is not yet valid)
18-
19-
The plug-in can be installed using the included update site:
20-
21-
update_site/update.site.zip
22-
23-
1) Unzip the file onto your local machine.
24-
25-
2) In Eclipse, browse to Help -> Install New Software.
26-
27-
3) Add a new local repository by clicking on the "Add..." button and browsing to the directory that you unzipped above (should contain a site.xml file). Make sure to name the repository and then click "Ok". You should now be able to select the repository in the "Work with:" drop down menu and the plug-in should appear in the list.
28-
29-
4) Select the plug-in:
30-
31-
Paho Client Eclipse View Feature
32-
33-
5) Click "Next" and follow the remaining instructions for installing the plug-in.
34-
35-
# Usage
36-
37-
The view can be accessed by navigating to Window -> Show View -> Other..., then expand the "M2M" folder and select "MQTT Tester View". This will open the interface for the MQTT view. The interface consists of three tabs: Connection, Publish, and Subscribe.
38-
39-
**Connection Tab**
40-
41-
This tab is used to connect the MQTT client to a broker. A connection must be established in order to publish and subscribe in the remaining tabs. Here is a brief description of the fields:
42-
43-
* Broker Address: (Required) The IP address or URL of the broker
44-
* Broker Port: (Required) The port number of the broker
45-
* Client ID: (Required) A unique identifier to connect with.
46-
* Username: A username, if required by the broker.
47-
* Password: A password, if required by the broker.
48-
* Keep Alive: (Required) The number of seconds between keep alive pings sent to the broker.
49-
* Clean Start: Whether or not to maintain subscriptions across disconnects.
50-
* LWT Enable: Whether to enable Last Will and Testament (LWT).
51-
* LWT Topic: The topic that the broker will publish the LWT on.
52-
* LWT Message: The message that the broker will publish for the LWT.
53-
* LWT QoS: The quality of service that the LWT will be published on.
54-
* LWT Retain: Whether to retain the LWT message.
55-
56-
**Publish Tab**
57-
58-
Used to publish messages to the broker. A message may be a string or a File. Here is a brief description of the fields:
59-
60-
* Topic: The topic to publish on.
61-
* QoS: The quality of service to publish on.
62-
* Retain: Whether to retain the message on the broker.
63-
* Payload: The payload to publish (if publishing a string).
64-
* File: The file to publish (if publishing a file).
65-
66-
**Subscribe Tab**
67-
68-
Used to subscribe and unsubscribe on topics. Once the client is subscribed to a topic, all messages received will be displayed in the log below. Here is a brief description of the fields:
69-
70-
* Topic: The topic to subscribe on (can include wildcards + and #)
71-
* QoS: The quality of service to subscribe on.
72-
73-
74-
# Building
75-
76-
The project requires the Plug-in Development Environment (PDE) in order to build. Information about installing the PDE tools can be found at:
77-
78-
[Eclipse PDE](www.eclipse.org/pde)
79-
80-
The source for the project itself can be found at:
81-
82-
[Eclipse Git](http://git.eclipse.org/c/paho/org.eclipse.paho.mqtt.esf.git/)
83-
84-
Once the project is imported into Eclipse, it can be build by right clicking on the project and navigating to Export -> Plug-in Development -> Deployable plug-ins and fragments.
85-
86-
87-
## Copyright
88-
89-
Copyright (c) 2012 Eurotech Inc. All rights reserved.
90-
91-
92-
## License
93-
94-
This project is released under the Eclipse Public License (EPL) version 1.0
95-
96-
97-
## Additional Resources
98-
99-
* [Eclipse Paho project](http://www.eclipse.org/paho/)
100-
101-
* [MQTT Community](http://www.mqtt.org)
102-
1+
**Project** Eclipse Paho MQTT Tester View
2+
3+
**Version** 1.0.3
4+
5+
**Date** 24-04-2013
6+
7+
**Author** Eurotech Inc.
8+
9+
10+
# Overview
11+
12+
The Eclipse Paho MQTT Tester View is an Eclipse plugin that provides a user interface for performing MQTT-based messaging tasks within Eclipse.
13+
14+
15+
# Installation
16+
17+
(TODO this section is not yet valid)
18+
19+
The plug-in can be installed using the included update site:
20+
21+
update_site/update.site.zip
22+
23+
1) Unzip the file onto your local machine.
24+
25+
2) In Eclipse, browse to Help -> Install New Software.
26+
27+
3) Add a new local repository by clicking on the "Add..." button and browsing to the directory that you unzipped above (should contain a site.xml file). Make sure to name the repository and then click "Ok". You should now be able to select the repository in the "Work with:" drop down menu and the plug-in should appear in the list.
28+
29+
4) Select the plug-in:
30+
31+
Paho Client Eclipse View Feature
32+
33+
5) Click "Next" and follow the remaining instructions for installing the plug-in.
34+
35+
# Usage
36+
37+
The view can be accessed by navigating to Window -> Show View -> Other..., then expand the "M2M" folder and select "MQTT Tester View". This will open the interface for the MQTT view. The interface consists of three tabs: Connection, Publish, and Subscribe.
38+
39+
**Connection Tab**
40+
41+
This tab is used to connect the MQTT client to a broker. A connection must be established in order to publish and subscribe in the remaining tabs. Here is a brief description of the fields:
42+
43+
* Broker Address: (Required) The IP address or URL of the broker
44+
* Broker Port: (Required) The port number of the broker
45+
* Client ID: (Required) A unique identifier to connect with.
46+
* Username: A username, if required by the broker.
47+
* Password: A password, if required by the broker.
48+
* Keep Alive: (Required) The number of seconds between keep alive pings sent to the broker.
49+
* Clean Start: Whether or not to maintain subscriptions across disconnects.
50+
* LWT Enable: Whether to enable Last Will and Testament (LWT).
51+
* LWT Topic: The topic that the broker will publish the LWT on.
52+
* LWT Message: The message that the broker will publish for the LWT.
53+
* LWT QoS: The quality of service that the LWT will be published on.
54+
* LWT Retain: Whether to retain the LWT message.
55+
56+
**Publish Tab**
57+
58+
Used to publish messages to the broker. A message may be a string or a File. Here is a brief description of the fields:
59+
60+
* Topic: The topic to publish on.
61+
* QoS: The quality of service to publish on.
62+
* Retain: Whether to retain the message on the broker.
63+
* Payload: The payload to publish (if publishing a string).
64+
* File: The file to publish (if publishing a file).
65+
66+
**Subscribe Tab**
67+
68+
Used to subscribe and unsubscribe on topics. Once the client is subscribed to a topic, all messages received will be displayed in the log below. Here is a brief description of the fields:
69+
70+
* Topic: The topic to subscribe on (can include wildcards + and #)
71+
* QoS: The quality of service to subscribe on.
72+
73+
74+
# Building
75+
76+
The project requires the Plug-in Development Environment (PDE) in order to build. Information about installing the PDE tools can be found at:
77+
78+
[Eclipse PDE](www.eclipse.org/pde)
79+
80+
The source for the project itself can be found at:
81+
82+
[Eclipse Git](http://git.eclipse.org/c/paho/org.eclipse.paho.mqtt.esf.git/)
83+
84+
Once the project is imported into Eclipse, it can be build by right clicking on the project and navigating to Export -> Plug-in Development -> Deployable plug-ins and fragments.
85+
86+
87+
## Copyright
88+
89+
Copyright (c) 2012 Eurotech Inc. All rights reserved.
90+
91+
92+
## License
93+
94+
This project is released under the Eclipse Public License (EPL) version 1.0
95+
96+
97+
## Additional Resources
98+
99+
* [Eclipse Paho project](http://www.eclipse.org/paho/)
100+
101+
* [MQTT Community](http://www.mqtt.org)
102+
Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
<?xml version="1.0" encoding="UTF-8"?>
2-
<plugin>
3-
<extension point="org.eclipse.ui.views">
4-
<category
5-
id="org.eclipse.ui.paho"
6-
name="M2M">
7-
</category>
8-
9-
<view id="org.eclipse.paho.client.eclipse.view.mqttclientview"
10-
name="Paho MQTT Exerciser"
11-
category="org.eclipse.ui.paho"
12-
class="org.eclipse.paho.client.eclipse.view.MqttClientView"
13-
icon="icons/mqtt_view.png"/>
14-
</extension>
15-
</plugin>
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<plugin>
3+
<extension point="org.eclipse.ui.views">
4+
<category
5+
id="org.eclipse.ui.paho"
6+
name="M2M">
7+
</category>
8+
9+
<view id="org.eclipse.paho.client.eclipse.view.mqttclientview"
10+
name="Paho MQTT Exerciser"
11+
category="org.eclipse.ui.paho"
12+
class="org.eclipse.paho.client.eclipse.view.MqttClientView"
13+
icon="icons/mqtt_view.png"/>
14+
</extension>
15+
</plugin>

0 commit comments

Comments
 (0)