Skip to contentSkip to conversation

Laptop driver documentation changes for 2.6.25

PATCH In review Carlos Corbacho 6 participants 16 messages Feb 9, 2008 – Mar 4, 2008

Subsystems (3)
Documentation ACPI Char and misc drivers
lore
Share & tools
lore

Carlos Corbacho

author
#0 lore raw

cover Laptop driver documentation changes for 2.6.25

The following series implements the proposed creation of Documentation/laptops, and the movement of all the laptop driver documentation to this directory. I've also taken the opportunity to tack on the acer-wmi documentation in the final patch of this series.

Because all the drivers in question go through the ACPI tree anyway, it's probably easiest if this change goes through the ACPI tree as well.

This should all be 2.6.25 material, since there is no code change here, just rearranging the Documentation files, and updating Kconfig entries where required. I've also tested this series against Linus' latest git tree, with no problems applying it there.

-Carlos
---

Carlos Corbacho (5):
acer-wmi - Add documentation
sonypi - Move sonypi.txt to Documentation/laptops sony-laptop - Move sony-laptop.txt to Documentation/laptops thinkpad-acpi - Move thinkpad-acpi.txt to Documentation/laptops Documentation - Create laptops sub-directory

 Documentation/00-INDEX                  |    8 
 Documentation/laptops/00-INDEX          |   10 
 Documentation/laptops/acer-wmi.txt      |  202 +++++
 Documentation/laptops/sony-laptop.txt   |  117 +++
 Documentation/laptops/sonypi.txt        |  152 +++
 Documentation/laptops/thinkpad-acpi.txt | 1365 +++++++++++++++++++++++++++++++
 Documentation/sony-laptop.txt           |  117 ---
 Documentation/sonypi.txt                |  152 ---
 Documentation/thinkpad-acpi.txt         | 1365 -------------------------------
 drivers/char/Kconfig                    |    2 
 drivers/misc/Kconfig                    |   10 
 11 files changed, 1856 insertions(+), 1644 deletions(-)
 create mode 100644 Documentation/laptops/00-INDEX
 create mode 100644 Documentation/laptops/acer-wmi.txt
 create mode 100644 Documentation/laptops/sony-laptop.txt
 create mode 100644 Documentation/laptops/sonypi.txt
 create mode 100644 Documentation/laptops/thinkpad-acpi.txt
 delete mode 100644 Documentation/sony-laptop.txt
 delete mode 100644 Documentation/sonypi.txt
 delete mode 100644 Documentation/thinkpad-acpi.txt
author
#1 lore raw

PATCH 1/5 Documentation - Create laptops sub-directory

There are currently various laptop drivers floating about with no central place for their documentation, which is currently scattered around the top level Documentation/ directory.

So, as a first step, lets create a Documentation sub-directory, and update the relevant index files. The work of then moving the existing laptop driver related documentation will then be handled later.

Signed-off-by Carlos Corbacho <[email protected]>
CC Randy Dunlap <[email protected]>
CC Henrique de Moraes Holschuh <[email protected]>
CC Mattia Dongili <[email protected]>
CC Len Brown <[email protected]>

---

 Documentation/00-INDEX         |    2 ++
 Documentation/laptops/00-INDEX |    2 ++
 2 files changed, 4 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/laptops/00-INDEX
Documentation/00-INDEX +2 -0
index 6e9c405..3de34e5 100644
@@ -227,6 +227,8 @@ kref.txt
 	- docs on adding reference counters (krefs) to kernel objects.
 laptop-mode.txt
 	- how to conserve battery power using laptop-mode.
+laptops/
+	- directory with laptop related info and laptop driver documentation.
 ldm.txt
 	- a brief description of LDM (Windows Dynamic Disks).
 leds-class.txt
Documentation/laptops/00-INDEX new file +2 -0
new file mode 100644
index 0000000..2edb596
@@ -0,0 +1,2 @@
+00-INDEX
+	- This file
author
#2 lore raw

PATCH 3/5 sony-laptop - Move sony-laptop.txt to Documentation/laptops

In reply to Carlos Corbacho

Also update references to sony-laptop.txt in Kconfig.

Signed-off-by Carlos Corbacho <[email protected]>
CC Len Brown <[email protected]>
CC Randy Dunlap <[email protected]>
CC Mattia Dongili <[email protected]>

---

 Documentation/00-INDEX                |    2 -
 Documentation/laptops/00-INDEX        |    2 +
 Documentation/laptops/sony-laptop.txt |  117 +++++++++++++++++++++++++++++++++
 Documentation/sony-laptop.txt         |  117 ---------------------------------
 drivers/misc/Kconfig                  |    2 -
 5 files changed, 120 insertions(+), 120 deletions(-)
 create mode 100644 Documentation/laptops/sony-laptop.txt
 delete mode 100644 Documentation/sony-laptop.txt
Documentation/00-INDEX +0 -2
index d69b2a3..012ef98 100644
@@ -353,8 +353,6 @@ sh/
 	- directory with info on porting Linux to a new architecture.
 smart-config.txt
 	- description of the Smart Config makefile feature.
-sony-laptop.txt
-	- Sony Notebook Control Driver (SNC) Readme.
 sonypi.txt
 	- info on Linux Sony Programmable I/O Device support.
 sound/
Documentation/laptops/00-INDEX +2 -0
index e806b08..c5bac77 100644
@@ -1,4 +1,6 @@
 00-INDEX
 	- This file
+sony-laptop.txt
+	- Sony Notebook Control Driver (SNC) Readme.
 thinkpad-acpi.txt
 	- information on the (IBM and Lenovo) ThinkPad ACPI Extras driver.
Documentation/laptops/sony-laptop.txt new file +117 -0

117 lines not on this page · raw message

Documentation/sony-laptop.txt deleted +0 -117

117 lines not on this page · raw message

drivers/misc/Kconfig +1 -1
index 5716d2e..e3c70cd 100644
@@ -183,7 +183,7 @@ config SONY_LAPTOP
 	  screen brightness control, Fn keys and allows powering on/off some
 	  devices.
 
-	  Read <file:Documentation/sony-laptop.txt> for more information.
+	  Read <file:Documentation/laptops/sony-laptop.txt> for more information.
 
 config SONYPI_COMPAT
 	bool "Sonypi compatibility"
author
#3 lore raw

PATCH 4/5 sonypi - Move sonypi.txt to Documentation/laptops

In reply to Carlos Corbacho

Also update references to sonypi.txt in Kconfig.

Signed-off-by Carlos Corbacho <[email protected]>
CC Randy Dunlap <[email protected]>
CC Mattia Dongili <[email protected]>
CC Len Brown <[email protected]>

---

 Documentation/00-INDEX           |    2 -
 Documentation/laptops/00-INDEX   |    2 +
 Documentation/laptops/sonypi.txt |  152 ++++++++++++++++++++++++++++++++++++++
 Documentation/sonypi.txt         |  152 --------------------------------------
 drivers/char/Kconfig             |    2 -
 5 files changed, 155 insertions(+), 155 deletions(-)
 create mode 100644 Documentation/laptops/sonypi.txt
 delete mode 100644 Documentation/sonypi.txt
Documentation/00-INDEX +0 -2
index 012ef98..8d55670 100644
@@ -353,8 +353,6 @@ sh/
 	- directory with info on porting Linux to a new architecture.
 smart-config.txt
 	- description of the Smart Config makefile feature.
-sonypi.txt
-	- info on Linux Sony Programmable I/O Device support.
 sound/
 	- directory with info on sound card support.
 sparc/
Documentation/laptops/00-INDEX +2 -0
index c5bac77..dbe1759 100644
@@ -2,5 +2,7 @@
 	- This file
 sony-laptop.txt
 	- Sony Notebook Control Driver (SNC) Readme.
+sonypi.txt
+	- info on Linux Sony Programmable I/O Device support.
 thinkpad-acpi.txt
 	- information on the (IBM and Lenovo) ThinkPad ACPI Extras driver.
Documentation/laptops/sonypi.txt new file +152 -0

152 lines not on this page · raw message

Documentation/sonypi.txt deleted +0 -152

152 lines not on this page · raw message

drivers/char/Kconfig +1 -1
index f01ac9a..47c6be8 100644
@@ -875,7 +875,7 @@ config SONYPI
 	  Device which can be found in many (all ?) Sony Vaio laptops.
 
 	  If you have one of those laptops, read
-	  <file:Documentation/sonypi.txt>, and say Y or M here.
+	  <file:Documentation/laptops/sonypi.txt>, and say Y or M here.
 
 	  To compile this driver as a module, choose M here: the
 	  module will be called sonypi.

-
To unsubscribe from this list: send the line "unsubscribe linux-acpi" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html

author
#4 lore raw

PATCH 5/5 acer-wmi - Add documentation

In reply to Carlos Corbacho

Add some initial documentation detailing what acer-wmi is, and how to use it. Update the Kconfig entry with a reference to the documentation.

Signed-off-by Carlos Corbacho <[email protected]>
CC Len Brown <[email protected]>
CC Randy Dunlap <[email protected]>

---

 Documentation/laptops/00-INDEX     |    2 
 Documentation/laptops/acer-wmi.txt |  202 ++++++++++++++++++++++++++++++++++++
 drivers/misc/Kconfig               |    3 +
 3 files changed, 207 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/laptops/acer-wmi.txt
Documentation/laptops/00-INDEX +2 -0
index dbe1759..729c2c0 100644
@@ -1,5 +1,7 @@
 00-INDEX
 	- This file
+acer-wmi.txt
+	- information on the Acer Laptop WMI Extras driver.
 sony-laptop.txt
 	- Sony Notebook Control Driver (SNC) Readme.
 sonypi.txt
Documentation/laptops/acer-wmi.txt new file +202 -0

202 lines not on this page · raw message

drivers/misc/Kconfig +3 -0
index e3c70cd..e47d424 100644
@@ -105,6 +105,9 @@ config ACER_WMI
 	  wireless radio and bluetooth control, and on some laptops,
 	  exposes the mail LED and LCD backlight.
 
+	  For more information about this driver see
+	  <file:Documentation/laptops/acer-wmi.txt>
+
 	  If you have an ACPI-WMI compatible Acer/ Wistron laptop, say Y or M
 	  here.
author
#5 lore raw
In reply to Carlos Corbacho
Quoted 1 line · On Saturday 09 February 2008 01:31:57 Carlos Corbacho wrote:

thinkpad-acpi - Move thinkpad-acpi.txt to Documentation/laptops

This patch [2/5] doesn't seem to have made it to the list. If it doesn't appear by the end of Saturday, I'll try resending it.

-Carlos

Signature · 3 lines
E-Mail: [email protected]
Web: strangeworlds.co.uk
GPG Key ID: 0x23EE722D
reviewer
#6 lore raw
Quoted 5 lines · Carlos Corbacho
Quoted 1 line · On Saturday 09 February 2008 01:31:57 Carlos Corbacho wrote:

thinkpad-acpi - Move thinkpad-acpi.txt to Documentation/laptops

This patch [2/5] doesn't seem to have made it to the list. If it doesn't appear by the end of Saturday, I'll try resending it.

it was 110K, which exceeded the 100K message size of the list.

i'm fine with these changes if everybody else is.

thanks,
-len

#7 lore raw
Quoted 10 lines · Len Brown
Quoted 5 lines · Carlos Corbacho
Quoted 1 line · On Saturday 09 February 2008 01:31:57 Carlos Corbacho wrote:

thinkpad-acpi - Move thinkpad-acpi.txt to Documentation/laptops

This patch [2/5] doesn't seem to have made it to the list. If it doesn't appear by the end of Saturday, I'll try resending it.

it was 110K, which exceeded the 100K message size of the list.

i'm fine with these changes if everybody else is.

As I said before, I am OK with them.

BTW Carlos, sending a git diff would have resulted in much smaller diffs (since git diff can do renames instead of add/delete) :) I believe all of us can deal just fine with git diffs, so it makes sense to use them in these cases.

Signature · 4 lines
  "One disk to rule them all, One disk to find them. One disk to bring
  them all and in the darkness grind them. In the Land of Redmond
  where the shadows lie." -- The Silicon Valley Tarot
  Henrique Holschuh
author
#8 lore raw
Quoted 4 lines · On Saturday 09 February 2008 18:22:17 Henrique de Moraes Holschuh wrote:

BTW Carlos, sending a git diff would have resulted in much smaller diffs (since git diff can do renames instead of add/delete) :) I believe all of us can deal just fine with git diffs, so it makes sense to use them in these cases.

I don't quite know what you mean here - experimenting in a tree here, git-diff doesn't produce any noticeable difference after using git-mv - unless this is a bug with StackedGit being unable to handle renames/ moves properly?

-Carlos

Signature · 3 lines
E-Mail: [email protected]
Web: strangeworlds.co.uk
GPG Key ID: 0x23EE722D
#9 lore raw
Quoted 9 lines · Carlos Corbacho
Quoted 4 lines · On Saturday 09 February 2008 18:22:17 Henrique de Moraes Holschuh wrote:

BTW Carlos, sending a git diff would have resulted in much smaller diffs (since git diff can do renames instead of add/delete) :) I believe all of us can deal just fine with git diffs, so it makes sense to use them in these cases.

I don't quite know what you mean here - experimenting in a tree here, git-diff doesn't produce any noticeable difference after using git-mv - unless this is a bug with StackedGit being unable to handle renames/ moves properly?

Randy sent you a much better email than mine about it, but here it goes:

hmh@thorin:/tmp/f$ git init 
Initialized empty Git repository in .git/
hmh@thorin:/tmp/f$ cp /var/log/Xorg.0.log .
hmh@thorin:/tmp/f$ git add .
hmh@thorin:/tmp/f$ git commit -m "initial commit"
Created initial commit 4e5f9c4: initial commit
 1 files changed, 1260 insertions(+), 0 deletions(-)
 create mode 100644 Xorg.0.log
hmh@thorin:/tmp/f$ git mv Xorg.0.log Xorg.1.log
hmh@thorin:/tmp/f$ git commit -m "move commit"
 Created commit ed5f8d0: move commit
 2 files changed, 1260 insertions(+), 1260 deletions(-)
 delete mode 100644 Xorg.0.log
 create mode 100644 Xorg.1.log
hmh@thorin:/tmp/f$ git diff HEAD^.. -M
Xorg.1.log renamed from Xorg.0.log +0 -0
similarity index 100%
rename from Xorg.0.log
rename to Xorg.1.log

The key is that -M (or -C for that matter). To be even more clear:

hmh@thorin:/tmp/f$ git diff HEAD^.. | wc
   2532   20098  134766
hmh@thorin:/tmp/f$ git diff HEAD^.. -M | wc
   4      13     103

So I really should have mentioned -M when I talked about git diffs :-(

Signature · 4 lines
  "One disk to rule them all, One disk to find them. One disk to bring
  them all and in the darkness grind them. In the Land of Redmond
  where the shadows lie." -- The Silicon Valley Tarot
  Henrique Holschuh
#10 lore raw
In reply to Len Brown
Quoted 10 lines · Len Brown
Quoted 5 lines · Carlos Corbacho
Quoted 1 line · On Saturday 09 February 2008 01:31:57 Carlos Corbacho wrote:

thinkpad-acpi - Move thinkpad-acpi.txt to Documentation/laptops

This patch [2/5] doesn't seem to have made it to the list. If it doesn't appear by the end of Saturday, I'll try resending it.

it was 110K, which exceeded the 100K message size of the list.

i'm fine with these changes if everybody else is.

Ok for me for sonypi.txt and sony-laptop.txt

Cheers

Signature · 2 lines
mattia
:wq!
Acked-by on the v1 series
#11 lore raw
In reply to Carlos Corbacho
Quoted 16 lines · On Sat, 09 Feb 2008 01:31:57 +0000 Carlos Corbacho wrote:

The following series implements the proposed creation of Documentation/laptops, and the movement of all the laptop driver documentation to this directory. I've also taken the opportunity to tack on the acer-wmi documentation in the final patch of this series.

Because all the drivers in question go through the ACPI tree anyway, it's probably easiest if this change goes through the ACPI tree as well.

This should all be 2.6.25 material, since there is no code change here, just rearranging the Documentation files, and updating Kconfig entries where required. I've also tested this series against Linus' latest git tree, with no problems applying it there.

-Carlos
---

Quoted 6 lines

Carlos Corbacho (5):
acer-wmi - Add documentation
sonypi - Move sonypi.txt to Documentation/laptops sony-laptop - Move sony-laptop.txt to Documentation/laptops thinkpad-acpi - Move thinkpad-acpi.txt to Documentation/laptops Documentation - Create laptops sub-directory

for_each:

Acked-by Randy Dunlap <[email protected].

Oh. If any of these are purely moved files (from one location to another), then that should show up in the git-diff diffstat. (I'm sure that Len knows about this.)
Ah, I finally found Linus's email on this. He says:

Please use "git diff -M --stat --summary" to generate the diffstat: the -M enables rename detection, and the summary enables a summary of new/deleted or renamed files.

Thanks.

Quoted 12 lines
 Documentation/00-INDEX                  |    8 
 Documentation/laptops/00-INDEX          |   10 
 Documentation/laptops/acer-wmi.txt      |  202 +++++
 Documentation/laptops/sony-laptop.txt   |  117 +++
 Documentation/laptops/sonypi.txt        |  152 +++
 Documentation/laptops/thinkpad-acpi.txt | 1365 +++++++++++++++++++++++++++++++
 Documentation/sony-laptop.txt           |  117 ---
 Documentation/sonypi.txt                |  152 ---
 Documentation/thinkpad-acpi.txt         | 1365 -------------------------------
 drivers/char/Kconfig                    |    2 
 drivers/misc/Kconfig                    |   10 
 11 files changed, 1856 insertions(+), 1644 deletions(-)
Quoted 8 lines
 create mode 100644 Documentation/laptops/00-INDEX
 create mode 100644 Documentation/laptops/acer-wmi.txt
 create mode 100644 Documentation/laptops/sony-laptop.txt
 create mode 100644 Documentation/laptops/sonypi.txt
 create mode 100644 Documentation/laptops/thinkpad-acpi.txt
 delete mode 100644 Documentation/sony-laptop.txt
 delete mode 100644 Documentation/sonypi.txt
 delete mode 100644 Documentation/thinkpad-acpi.txt

---
~Randy

#12 lore raw
In reply to Carlos Corbacho
Quoted 5 lines · On Sat, 09 Feb 2008 01:31:57 +0000 Carlos Corbacho wrote:

The following series implements the proposed creation of Documentation/laptops, and the movement of all the laptop driver documentation to this directory. I've also taken the opportunity to tack on the acer-wmi documentation in the final patch of this series.

Quoted 8 lines

Because all the drivers in question go through the ACPI tree anyway, it's probably easiest if this change goes through the ACPI tree as well.

This should all be 2.6.25 material, since there is no code change here, just rearranging the Documentation files, and updating Kconfig entries where required. I've also tested this series against Linus' latest git tree, with no problems applying it there.

Hi,
so should we also move Documentation/laptop-mode.txt to laptops/ dir?

Quoted 21 lines

Carlos Corbacho (5):
acer-wmi - Add documentation
sonypi - Move sonypi.txt to Documentation/laptops sony-laptop - Move sony-laptop.txt to Documentation/laptops thinkpad-acpi - Move thinkpad-acpi.txt to Documentation/laptops Documentation - Create laptops sub-directory

 Documentation/00-INDEX                  |    8 
 Documentation/laptops/00-INDEX          |   10 
 Documentation/laptops/acer-wmi.txt      |  202 +++++
 Documentation/laptops/sony-laptop.txt   |  117 +++
 Documentation/laptops/sonypi.txt        |  152 +++
 Documentation/laptops/thinkpad-acpi.txt | 1365 +++++++++++++++++++++++++++++++
 Documentation/sony-laptop.txt           |  117 ---
 Documentation/sonypi.txt                |  152 ---
 Documentation/thinkpad-acpi.txt         | 1365 -------------------------------
 drivers/char/Kconfig                    |    2 
 drivers/misc/Kconfig                    |   10 
 11 files changed, 1856 insertions(+), 1644 deletions(-)
Quoted 8 lines
 create mode 100644 Documentation/laptops/00-INDEX
 create mode 100644 Documentation/laptops/acer-wmi.txt
 create mode 100644 Documentation/laptops/sony-laptop.txt
 create mode 100644 Documentation/laptops/sonypi.txt
 create mode 100644 Documentation/laptops/thinkpad-acpi.txt
 delete mode 100644 Documentation/sony-laptop.txt
 delete mode 100644 Documentation/sonypi.txt
 delete mode 100644 Documentation/thinkpad-acpi.txt

---
~Randy

author
#13 lore raw
Quoted 9 lines · On Monday 11 February 2008 19:23:39 Randy Dunlap wrote:
Quoted 8 lines · On Sat, 09 Feb 2008 01:31:57 +0000 Carlos Corbacho wrote:

The following series implements the proposed creation of Documentation/laptops, and the movement of all the laptop driver documentation to this directory. I've also taken the opportunity to tack on the acer-wmi documentation in the final patch of this series.

Because all the drivers in question go through the ACPI tree anyway, it's probably easiest if this change goes through the ACPI tree as well.

Quoted 7 lines
Quoted 4 lines

This should all be 2.6.25 material, since there is no code change here, just rearranging the Documentation files, and updating Kconfig entries where required. I've also tested this series against Linus' latest git tree, with no problems applying it there.

Hi,
so should we also move Documentation/laptop-mode.txt to laptops/ dir?

[CC'ing Bart Samwel on this, as he wrote Documentation/laptop-mode.txt]

Yes, we probably should.

-Carlos

Signature · 3 lines
E-Mail: [email protected]
Web: strangeworlds.co.uk
GPG Key ID: 0x23EE722D
#14 lore raw
Quoted 15 lines · On Mon, 11 Feb 2008 19:29:29 +0000 Carlos Corbacho wrote:
Quoted 14 lines · On Monday 11 February 2008 19:23:39 Randy Dunlap wrote:
Quoted 12 lines · On Sat, 09 Feb 2008 01:31:57 +0000 Carlos Corbacho wrote:

The following series implements the proposed creation of Documentation/laptops, and the movement of all the laptop driver documentation to this directory. I've also taken the opportunity to tack on the acer-wmi documentation in the final patch of this series.

Because all the drivers in question go through the ACPI tree anyway, it's probably easiest if this change goes through the ACPI tree as well.

This should all be 2.6.25 material, since there is no code change here, just rearranging the Documentation files, and updating Kconfig entries where required. I've also tested this series against Linus' latest git tree, with no problems applying it there.

Quoted 6 lines
Quoted 2 lines

Hi,
so should we also move Documentation/laptop-mode.txt to laptops/ dir?

[CC'ing Bart Samwel on this, as he wrote Documentation/laptop-mode.txt]

Yes, we probably should.

Hi Bart,
Is that OK with you?
if we move laptop-mode.txt to the Documenation/laptops/ sub-directory?

---
~Randy

#15 lore raw
Quoted 18 lines · Randy Dunlap
Quoted 16 lines · On Mon, 11 Feb 2008 19:29:29 +0000 Carlos Corbacho wrote:
Quoted 15 lines · On Monday 11 February 2008 19:23:39 Randy Dunlap wrote:
Quoted 5 lines · On Sat, 09 Feb 2008 01:31:57 +0000 Carlos Corbacho wrote:

The following series implements the proposed creation of Documentation/laptops, and the movement of all the laptop driver documentation to this directory. I've also taken the opportunity to tack on the acer-wmi documentation in the final patch of this series.

Quoted 7 lines

Because all the drivers in question go through the ACPI tree anyway, it's probably easiest if this change goes through the ACPI tree as well.

This should all be 2.6.25 material, since there is no code change here, just rearranging the Documentation files, and updating Kconfig entries where required. I've also tested this series against Linus' latest git tree, with no problems applying it there.

Hi,
so should we also move Documentation/laptop-mode.txt to laptops/ dir?

Quoted 7 lines
Quoted 3 lines

[CC'ing Bart Samwel on this, as he wrote Documentation/laptop-mode.txt]

Yes, we probably should.

Hi Bart,
Is that OK with you?
if we move laptop-mode.txt to the Documenation/laptops/ sub-directory?

Sounds fine by me!

Cheers,
Bart