Opened 3 years ago

Closed 2 years ago

#3484 closed task (complete)

Kea4 Developer's guide page needs update

Reported by: tomek Owned by: marcin
Priority: low Milestone: Kea0.9.2
Component: dhcp4 Version: git
Keywords: Cc:
CVSS Scoring: Parent Tickets:
Sensitive: no Defect Severity: N/A
Sub-Project: DHCP Feature Depending on Ticket:
Estimated Difficulty: 0 Add Hours to Ticket: 0
Total Hours: 0 Internal?: no

Description

src/bin/dhcp4/dhcp4.dox needs an update. It talks about message queue integration, for example. Other sections also need a review and probably a refresh.

Subtickets

Change History (11)

comment:1 Changed 3 years ago by tomek

  • Milestone changed from Kea-proposed to Kea1.0

comment:2 Changed 3 years ago by tomek

  • Milestone changed from Kea1.0 to Kea0.9.1
  • Version set to git

comment:3 Changed 3 years ago by hschempf

  • Milestone changed from Kea0.9.1 to Kea0.9.2

comment:4 Changed 2 years ago by tomek

  • Milestone changed from Kea0.9.2 to Kea0.9.2-final

comment:5 Changed 2 years ago by marcin

We should make sure that the BIND10 logo is removed from the Developer's Guide main page.

comment:6 Changed 2 years ago by marcin

Another issue is to remove the "How to Add a New Configuration Backend" section from the Developer's Guide.

comment:7 Changed 2 years ago by marcin

  • Owner changed from UnAssigned to marcin
  • Status changed from new to accepted

comment:8 Changed 2 years ago by marcin

  • Owner changed from marcin to UnAssigned
  • Status changed from accepted to reviewing

I have gone through the whole Doxygen documentation and updated what was outdated, applied some editorial issues, removed non-relevant sections etc. I also fixed a couple of doxygen warnings.

There are many files changed in many places, but those changes are mostly trivial, so the review should not be a pain. Also I split it to many commits so as it is easier to distinguish specific changes.

Proposed ChangeLog entry

XXX.	[doc]		marcin
	Updated Developer's Guide.
	(Trac #3484, git abcd)

Last edited 2 years ago by marcin (previous) (diff)

comment:9 Changed 2 years ago by stephen

  • Owner changed from UnAssigned to stephen

comment:10 follow-up: Changed 2 years ago by stephen

  • Owner changed from stephen to marcin

Reviewed commit 4410b04b5edd9f9467478cd8ffed33dc19819bcd

Instead of pointing out small errors, I've edited the files directly and corrected them. Please pull and review the changes.

doc/devel/contribute.dox
The existing text explained how to develop and test code. I've taken the liberty of expanding the section on testing to add the reasons why the unit tests should be done in the way described.

ChangeLog
Proposed text is OK.

comment:11 in reply to: ↑ 10 Changed 2 years ago by marcin

  • Resolution set to complete
  • Status changed from reviewing to closed

Replying to stephen:

Reviewed commit 4410b04b5edd9f9467478cd8ffed33dc19819bcd

Instead of pointing out small errors, I've edited the files directly and corrected them. Please pull and review the changes.

Thanks for the updates. I have reviewed your changes and they look ok.

doc/devel/contribute.dox
The existing text explained how to develop and test code. I've taken the liberty of expanding the section on testing to add the reasons why the unit tests should be done in the way described.

This text is also ok, and seems to be better than mine. ;-)

ChangeLog
Proposed text is OK.

Thanks.

Merged with commit 220c337c31a592311363eca981c7f1578abbe15d

Note: See TracTickets for help on using tickets.