celix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pnol...@apache.org
Subject celix git commit: CELIX-368: Updates some small issues in the documentation of dep man
Date Thu, 21 Jul 2016 12:39:00 GMT
Repository: celix
Updated Branches:
  refs/heads/develop 8160dec5d -> 8778ce59f


CELIX-368: Updates some small issues in the documentation of dep man


Project: http://git-wip-us.apache.org/repos/asf/celix/repo
Commit: http://git-wip-us.apache.org/repos/asf/celix/commit/8778ce59
Tree: http://git-wip-us.apache.org/repos/asf/celix/tree/8778ce59
Diff: http://git-wip-us.apache.org/repos/asf/celix/diff/8778ce59

Branch: refs/heads/develop
Commit: 8778ce59f1a60614fec0209d96332a01dfce1d9c
Parents: 8160dec
Author: Pepijn Noltes <pepijnnoltes@gmail.com>
Authored: Thu Jul 21 14:38:32 2016 +0200
Committer: Pepijn Noltes <pepijnnoltes@gmail.com>
Committed: Thu Jul 21 14:38:32 2016 +0200

----------------------------------------------------------------------
 dependency_manager/README.md       | 14 ++++++--------
 documents/best_practices/README.md |  2 +-
 2 files changed, 7 insertions(+), 9 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/celix/blob/8778ce59/dependency_manager/README.md
----------------------------------------------------------------------
diff --git a/dependency_manager/README.md b/dependency_manager/README.md
index b0a3a3c..d2201bf 100644
--- a/dependency_manager/README.md
+++ b/dependency_manager/README.md
@@ -111,13 +111,11 @@ celix_status_t dm_destroy(void * userData, bundle_context_pt context,
dm_depende
     return CELIX_SUCCESS;
 }  
 ```
+### References
 
-TODOS:
+For more information examples please see
 
-    1. add cmp callbacks
-    1. add interface
-    1. add service dependency and callbacks
-
-### Example
-
-For a more complete overview what can be done with the dependency manager please look at
the dm_example example. Should be located at 'examples/dm_example'.
+- [Best practices](../documents/best_practices/README.md): A introduction how to work with
services using the dependency manager
+- [The Dependency Manager API](public/include): The dependency manager header files
+- [Best practice example](../examples/best_practice_example): A best practice example (also
refered to in the Best practices documentation
+- [Dm example](../examples/dm_example): A DM example project.  

http://git-wip-us.apache.org/repos/asf/celix/blob/8778ce59/documents/best_practices/README.md
----------------------------------------------------------------------
diff --git a/documents/best_practices/README.md b/documents/best_practices/README.md
index 63a61c9..4a16cc8 100644
--- a/documents/best_practices/README.md
+++ b/documents/best_practices/README.md
@@ -74,7 +74,7 @@ Changes considered backwards compatible which does not extend the functionaility
  
 ## Components
 
-Component should use the ADT principle (see [http://lmgtfy.com/?q=ADT+in+C](http://lmgtfy.com/?q=ADT+in+C)).
+Component should use the ADT principle (see [ADT in C](http://inst.eecs.berkeley.edu/~selfpace/studyguide/9C.sg/Output/ADTs.in.C.html)).
 
 Components should have a `<cmpName>_create` and `<cmpName>_destroy` function.
 Components can have a `<cmpName>_start` and `<cmpName>_stop` function to start/stop
threads or invoke functionality needed a fully created component. 


Mime
View raw message