Skip to content

Commit

Permalink
Reporting: Encourage people to use github instead of mailing list
Browse files Browse the repository at this point in the history
  • Loading branch information
@mrdeep1
mrdeep1 committed Apr 23, 2024
1 parent c081bb6 commit 749e16f
Show file tree
Hide file tree
Showing 36 changed files with 187 additions and 105 deletions.
18 changes: 16 additions & 2 deletions CONTRIBUTE
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,18 @@ libcoap library.

2. Communications
~~~~~~~~~~~~~~~~~
The main discussion and development platform for libcoap is the mailing list
on Sourceforge.
The best method to raise an Issue is to raise it at:

https://github.com/obgm/libcoap/issues

Previous issues and fixes can easily be researched here.

The best method to create a patch is to create a Pull Request at:

https://github.com/obgm/libcoap/pulls

Otherwise, the main discussion and development platform for libcoap is the
mailing list on Sourceforge.

No matter if you just have a simple question, some specific problem or
want to discuss some patches, please write it to the mailing list. Please
Expand Down Expand Up @@ -187,6 +197,10 @@ coap_add_block(coap_pdu_t *pdu,
header files as they are the public part of the libcoap and only use the
@-syntax for doxygen commands (akin to javadoc).

* There are also man(1) pages to document how to use the APIs, held in the man/
directory. Any API changes or new APIs should be documented here to aid
development for other users.

5.5 API Changes
---------------
* Never break the API!
Expand Down
2 changes: 1 addition & 1 deletion configure.ac
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1194,7 +1194,7 @@ case $host in

*)
AC_MSG_WARN([==> Currently unsupported operating system '${host}' !])
AC_MSG_ERROR([==> If you can provide patches to support your operating system please write to '[email protected]'.])
AC_MSG_ERROR([==> If you can provide patches to support your operating system please raise a Pull Request at 'https://github.com/obgm/libcoap/pulls'.])
esac

# Exporting the PREDEFINED_CFLAGS definition
Expand Down
8 changes: 5 additions & 3 deletions man/coap-client.txt.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -325,9 +325,11 @@ SEE ALSO

BUGS
-----
Please report bugs on the mailing list for libcoap:
[email protected] or raise an issue on GitHub at
https://github.com/obgm/libcoap/issues
Please raise an issue on GitHub at
https://github.com/obgm/libcoap/issues to report any bugs.

Please raise a Pull Request at https://github.com/obgm/libcoap/pulls
for any fixes.

AUTHORS
-------
Expand Down
8 changes: 5 additions & 3 deletions man/coap-oscore-conf.txt.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -223,9 +223,11 @@ for further information.

BUGS
-----
Please report bugs on the mailing list for libcoap:
[email protected] or raise an issue on GitHub at
https://github.com/obgm/libcoap/issues
Please raise an issue on GitHub at
https://github.com/obgm/libcoap/issues to report any bugs.

Please raise a Pull Request at https://github.com/obgm/libcoap/pulls
for any fixes.

AUTHORS
-------
Expand Down
8 changes: 5 additions & 3 deletions man/coap-rd.txt.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -166,9 +166,11 @@ EXIT STATUS

BUGS
-----
Please report bugs on the mailing list for libcoap:
[email protected] or raise an issue on GitHub at
https://github.com/obgm/libcoap/issues
Please raise an issue on GitHub at
https://github.com/obgm/libcoap/issues to report any bugs.

Please raise a Pull Request at https://github.com/obgm/libcoap/pulls
for any fixes.

AUTHORS
-------
Expand Down
8 changes: 5 additions & 3 deletions man/coap-server.txt.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -305,9 +305,11 @@ SEE ALSO

BUGS
-----
Please report bugs on the mailing list for libcoap:
[email protected] or raise an issue on GitHub at
https://github.com/obgm/libcoap/issues
Please raise an issue on GitHub at
https://github.com/obgm/libcoap/issues to report any bugs.

Please raise a Pull Request at https://github.com/obgm/libcoap/pulls
for any fixes.

AUTHORS
-------
Expand Down
8 changes: 5 additions & 3 deletions man/coap.txt.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,11 @@ for further information.

BUGS
----
Please report bugs on the mailing list for libcoap:
[email protected] or raise an issue on GitHub at
https://github.com/obgm/libcoap/issues
Please raise an issue on GitHub at
https://github.com/obgm/libcoap/issues to report any bugs.

Please raise a Pull Request at https://github.com/obgm/libcoap/pulls
for any fixes.

AUTHORS
-------
Expand Down
8 changes: 5 additions & 3 deletions man/coap_address.txt.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -302,9 +302,11 @@ for further information.

BUGS
----
Please report bugs on the mailing list for libcoap:
[email protected] or raise an issue on GitHub at
https://github.com/obgm/libcoap/issues
Please raise an issue on GitHub at
https://github.com/obgm/libcoap/issues to report any bugs.

Please raise a Pull Request at https://github.com/obgm/libcoap/pulls
for any fixes.

AUTHORS
-------
Expand Down
8 changes: 5 additions & 3 deletions man/coap_async.txt.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -221,9 +221,11 @@ for further information.

BUGS
----
Please report bugs on the mailing list for libcoap:
[email protected] or raise an issue on GitHub at
https://github.com/obgm/libcoap/issues
Please raise an issue on GitHub at
https://github.com/obgm/libcoap/issues to report any bugs.

Please raise a Pull Request at https://github.com/obgm/libcoap/pulls
for any fixes.

AUTHORS
-------
Expand Down
8 changes: 5 additions & 3 deletions man/coap_attribute.txt.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -180,9 +180,11 @@ for further information.

BUGS
----
Please report bugs on the mailing list for libcoap:
[email protected] or raise an issue on GitHub at
https://github.com/obgm/libcoap/issues
Please raise an issue on GitHub at
https://github.com/obgm/libcoap/issues to report any bugs.

Please raise a Pull Request at https://github.com/obgm/libcoap/pulls
for any fixes.

AUTHORS
-------
Expand Down
8 changes: 5 additions & 3 deletions man/coap_block.txt.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -593,9 +593,11 @@ for further information.

BUGS
----
Please report bugs on the mailing list for libcoap:
[email protected] or raise an issue on GitHub at
https://github.com/obgm/libcoap/issues
Please raise an issue on GitHub at
https://github.com/obgm/libcoap/issues to report any bugs.

Please raise a Pull Request at https://github.com/obgm/libcoap/pulls
for any fixes.

AUTHORS
-------
Expand Down
8 changes: 5 additions & 3 deletions man/coap_cache.txt.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -419,9 +419,11 @@ for further information.

BUGS
----
Please report bugs on the mailing list for libcoap:
[email protected] or raise an issue on GitHub at
https://github.com/obgm/libcoap/issues
Please raise an issue on GitHub at
https://github.com/obgm/libcoap/issues to report any bugs.

Please raise a Pull Request at https://github.com/obgm/libcoap/pulls
for any fixes.

AUTHORS
-------
Expand Down
8 changes: 5 additions & 3 deletions man/coap_context.txt.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -192,9 +192,11 @@ for further information.

BUGS
----
Please report bugs on the mailing list for libcoap:
[email protected] or raise an issue on GitHub at
https://github.com/obgm/libcoap/issues
Please raise an issue on GitHub at
https://github.com/obgm/libcoap/issues to report any bugs.

Please raise a Pull Request at https://github.com/obgm/libcoap/pulls
for any fixes.

AUTHORS
-------
Expand Down
8 changes: 5 additions & 3 deletions man/coap_deprecated.txt.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -206,9 +206,11 @@ for further information.

BUGS
----
Please report bugs on the mailing list for libcoap:
[email protected] or raise an issue on GitHub at
https://github.com/obgm/libcoap/issues
Please raise an issue on GitHub at
https://github.com/obgm/libcoap/issues to report any bugs.

Please raise a Pull Request at https://github.com/obgm/libcoap/pulls
for any fixes.

AUTHORS
-------
Expand Down
8 changes: 5 additions & 3 deletions man/coap_encryption.txt.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1245,9 +1245,11 @@ for further information.

BUGS
----
Please report bugs on the mailing list for libcoap:
[email protected] or raise an issue on GitHub at
https://github.com/obgm/libcoap/issues
Please raise an issue on GitHub at
https://github.com/obgm/libcoap/issues to report any bugs.

Please raise a Pull Request at https://github.com/obgm/libcoap/pulls
for any fixes.

AUTHORS
-------
Expand Down
8 changes: 5 additions & 3 deletions man/coap_endpoint_client.txt.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -530,9 +530,11 @@ for further information.

BUGS
----
Please report bugs on the mailing list for libcoap:
[email protected] or raise an issue on GitHub at
https://github.com/obgm/libcoap/issues
Please raise an issue on GitHub at
https://github.com/obgm/libcoap/issues to report any bugs.

Please raise a Pull Request at https://github.com/obgm/libcoap/pulls
for any fixes.

AUTHORS
-------
Expand Down
8 changes: 5 additions & 3 deletions man/coap_endpoint_server.txt.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -583,9 +583,11 @@ for further information.

BUGS
----
Please report bugs on the mailing list for libcoap:
[email protected] or raise an issue on GitHub at
https://github.com/obgm/libcoap/issues
Please raise an issue on GitHub at
https://github.com/obgm/libcoap/issues to report any bugs.

Please raise a Pull Request at https://github.com/obgm/libcoap/pulls
for any fixes.

AUTHORS
-------
Expand Down
8 changes: 5 additions & 3 deletions man/coap_handler.txt.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -402,9 +402,11 @@ for further information.

BUGS
----
Please report bugs on the mailing list for libcoap:
[email protected] or raise an issue on GitHub at
https://github.com/obgm/libcoap/issues
Please raise an issue on GitHub at
https://github.com/obgm/libcoap/issues to report any bugs.

Please raise a Pull Request at https://github.com/obgm/libcoap/pulls
for any fixes.

AUTHORS
-------
Expand Down
8 changes: 5 additions & 3 deletions man/coap_init.txt.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,11 @@ for further information.

BUGS
----
Please report bugs on the mailing list for libcoap:
[email protected] or raise an issue on GitHub at
https://github.com/obgm/libcoap/issues
Please raise an issue on GitHub at
https://github.com/obgm/libcoap/issues to report any bugs.

Please raise a Pull Request at https://github.com/obgm/libcoap/pulls
for any fixes.

AUTHORS
-------
Expand Down
8 changes: 5 additions & 3 deletions man/coap_io.txt.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -508,9 +508,11 @@ for further information.

BUGS
----
Please report bugs on the mailing list for libcoap:
[email protected] or raise an issue on GitHub at
https://github.com/obgm/libcoap/issues
Please raise an issue on GitHub at
https://github.com/obgm/libcoap/issues to report any bugs.

Please raise a Pull Request at https://github.com/obgm/libcoap/pulls
for any fixes.

AUTHORS
-------
Expand Down
8 changes: 5 additions & 3 deletions man/coap_keepalive.txt.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,11 @@ for further information.

BUGS
----
Please report bugs on the mailing list for libcoap:
[email protected] or raise an issue on GitHub at
https://github.com/obgm/libcoap/issues
Please raise an issue on GitHub at
https://github.com/obgm/libcoap/issues to report any bugs.

Please raise a Pull Request at https://github.com/obgm/libcoap/pulls
for any fixes.

AUTHORS
-------
Expand Down
8 changes: 5 additions & 3 deletions man/coap_locking.txt.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -173,9 +173,11 @@ for further information.

BUGS
----
Please report bugs on the mailing list for libcoap:
[email protected] or raise an issue on GitHub at
https://github.com/obgm/libcoap/issues
Please raise an issue on GitHub at
https://github.com/obgm/libcoap/issues to report any bugs.

Please raise a Pull Request at https://github.com/obgm/libcoap/pulls
for any fixes.

AUTHORS
-------
Expand Down
8 changes: 5 additions & 3 deletions man/coap_logging.txt.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -351,9 +351,11 @@ for further information.

BUGS
----
Please report bugs on the mailing list for libcoap:
[email protected] or raise an issue on GitHub at
https://github.com/obgm/libcoap/issues
Please raise an issue on GitHub at
https://github.com/obgm/libcoap/issues to report any bugs.

Please raise a Pull Request at https://github.com/obgm/libcoap/pulls
for any fixes.

AUTHORS
-------
Expand Down
8 changes: 5 additions & 3 deletions man/coap_lwip.txt.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,11 @@ for further information.

BUGS
----
Please report bugs on the mailing list for libcoap:
[email protected] or raise an issue on GitHub at
https://github.com/obgm/libcoap/issues
Please raise an issue on GitHub at
https://github.com/obgm/libcoap/issues to report any bugs.

Please raise a Pull Request at https://github.com/obgm/libcoap/pulls
for any fixes.

AUTHORS
-------
Expand Down
8 changes: 5 additions & 3 deletions man/coap_observe.txt.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -428,9 +428,11 @@ for further information.

BUGS
----
Please report bugs on the mailing list for libcoap:
[email protected] or raise an issue on GitHub at
https://github.com/obgm/libcoap/issues
Please raise an issue on GitHub at
https://github.com/obgm/libcoap/issues to report any bugs.

Please raise a Pull Request at https://github.com/obgm/libcoap/pulls
for any fixes.

AUTHORS
-------
Expand Down
Loading

0 comments on commit 749e16f

Please sign in to comment.